Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0889405d84 | |||
| edd160d112 | |||
| 09a833b317 | |||
| 206eb51961 |
@@ -1,31 +0,0 @@
|
||||
# EditorConfig for go-micro
|
||||
# https://editorconfig.org
|
||||
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.go]
|
||||
indent_style = tab
|
||||
indent_size = 4
|
||||
|
||||
[*.{yml,yaml}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[*.{json,proto}]
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
|
||||
[Makefile]
|
||||
indent_style = tab
|
||||
|
||||
@@ -26,26 +26,19 @@ A clear and concise description of what you expected to happen.
|
||||
|
||||
## Environment
|
||||
- Go Micro version: [e.g. v5.3.0]
|
||||
- Go version: [run `go version`]
|
||||
- OS/Platform: [e.g. Ubuntu 22.04, macOS 14, Docker]
|
||||
- Plugins/Integrations: [e.g. consul registry, nats broker, redis cache]
|
||||
- Go version: [e.g. 1.21.0]
|
||||
- OS: [e.g. Ubuntu 22.04]
|
||||
- Plugins used: [e.g. consul registry, nats broker]
|
||||
|
||||
## Logs
|
||||
```
|
||||
Paste relevant logs here (use -v flag for verbose output)
|
||||
Paste relevant logs here
|
||||
```
|
||||
|
||||
## Checklist
|
||||
- [ ] I've searched existing issues and this is not a duplicate
|
||||
- [ ] I've provided a minimal code sample that reproduces the issue
|
||||
- [ ] I've included my environment details
|
||||
- [ ] I've checked the documentation
|
||||
|
||||
## Additional context
|
||||
Add any other context about the problem here.
|
||||
|
||||
## Helpful Resources
|
||||
- [Troubleshooting Guide](https://github.com/micro/go-micro/tree/master/internal/website/docs/getting-started.md)
|
||||
- [Examples](https://github.com/micro/go-micro/tree/master/examples)
|
||||
## Resources
|
||||
- [Documentation](https://github.com/micro/go-micro/tree/master/internal/website/docs)
|
||||
- [Examples](https://github.com/micro/go-micro/tree/master/internal/website/docs/examples)
|
||||
- [API Reference](https://pkg.go.dev/go-micro.dev/v5)
|
||||
- [Discord Community](https://discord.gg/WeMU5AGxD)
|
||||
|
||||
@@ -18,25 +18,13 @@ A clear and concise description of any alternative solutions or features you've
|
||||
## Use case
|
||||
Describe how this feature would be used in practice. What problem does it solve?
|
||||
|
||||
**Example:**
|
||||
```go
|
||||
// Show how the feature would be used
|
||||
```
|
||||
|
||||
## Implementation ideas (optional)
|
||||
If you have thoughts on how this could be implemented, share them here.
|
||||
|
||||
## Additional context
|
||||
Add any other context, code examples, or screenshots about the feature request here.
|
||||
|
||||
## Checklist
|
||||
- [ ] I've searched existing issues and this is not a duplicate
|
||||
- [ ] I've checked the roadmap and this isn't already planned
|
||||
- [ ] I've provided a clear use case
|
||||
- [ ] I'd be willing to submit a PR for this feature (optional)
|
||||
## Willing to contribute?
|
||||
- [ ] I'd be willing to submit a PR for this feature
|
||||
|
||||
## Helpful Resources
|
||||
## Resources
|
||||
- [Documentation](https://github.com/micro/go-micro/tree/master/internal/website/docs)
|
||||
- [Plugins](https://github.com/micro/go-micro/tree/master/internal/website/docs/plugins.md)
|
||||
- [Roadmap](https://github.com/micro/go-micro/blob/master/ROADMAP.md)
|
||||
- [Contributing Guide](https://github.com/micro/go-micro/blob/master/CONTRIBUTING.md)
|
||||
- [Architecture Docs](https://github.com/micro/go-micro/tree/master/internal/website/docs/architecture.md)
|
||||
- [Discord Community](https://discord.gg/WeMU5AGxD)
|
||||
|
||||
@@ -1,61 +0,0 @@
|
||||
---
|
||||
name: Performance issue
|
||||
about: Report a performance problem or regression
|
||||
title: '[PERFORMANCE] '
|
||||
labels: performance
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
## Performance Issue
|
||||
|
||||
**Symptom:**
|
||||
Describe the performance problem (e.g., high latency, memory leak, CPU usage)
|
||||
|
||||
**Expected Performance:**
|
||||
What performance did you expect?
|
||||
|
||||
## Benchmarks
|
||||
|
||||
Please provide benchmarks or profiling data:
|
||||
|
||||
```bash
|
||||
# CPU profiling
|
||||
go test -cpuprofile=cpu.prof -bench=.
|
||||
|
||||
# Memory profiling
|
||||
go test -memprofile=mem.prof -bench=.
|
||||
|
||||
# Results
|
||||
```
|
||||
|
||||
**Before/After comparison (if applicable):**
|
||||
- Before: X req/sec, Y ms latency
|
||||
- After: X req/sec, Y ms latency
|
||||
|
||||
## Code Sample
|
||||
|
||||
```go
|
||||
// Minimal code that demonstrates the performance issue
|
||||
```
|
||||
|
||||
## Environment
|
||||
- Go Micro version: [e.g. v5.3.0]
|
||||
- Go version: [run `go version`]
|
||||
- Hardware: [e.g. 4 CPU, 8GB RAM]
|
||||
- OS: [e.g. Ubuntu 22.04]
|
||||
- Load: [e.g. 1000 req/sec, 100 concurrent connections]
|
||||
|
||||
## Profiling Data
|
||||
|
||||
Attach pprof profiles if available:
|
||||
- CPU profile
|
||||
- Memory profile
|
||||
- Goroutine dump
|
||||
|
||||
## Additional Context
|
||||
|
||||
Add any other context about the performance issue.
|
||||
|
||||
## Resources
|
||||
- [Performance Guide](https://github.com/micro/go-micro/tree/master/internal/website/docs/performance.md)
|
||||
- [Benchmarking](https://pkg.go.dev/testing#hdr-Benchmarks)
|
||||
@@ -1,51 +0,0 @@
|
||||
name: goreleaser
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*.*.*'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
id-token: write
|
||||
packages: write
|
||||
attestations: write
|
||||
jobs:
|
||||
goreleaser:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
-
|
||||
name: Set up Go
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: stable
|
||||
-
|
||||
name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
-
|
||||
name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
-
|
||||
name: Login to GitHub Container Registry
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ghcr.io
|
||||
username: ${{ github.repository_owner }}
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
-
|
||||
name: Run GoReleaser
|
||||
uses: goreleaser/goreleaser-action@v7
|
||||
with:
|
||||
distribution: goreleaser
|
||||
version: '~> v2'
|
||||
args: release --clean
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -1,59 +0,0 @@
|
||||
name: Universe (E2E)
|
||||
|
||||
# Spins up a mini go-micro world end-to-end — services, a durable flow
|
||||
# that crashes and resumes, and an agent — then shuts it down. Everything
|
||||
# is real except the LLM, which is mocked, so the default job is
|
||||
# deterministic and needs no secrets. A second job runs the same scenario
|
||||
# against a live model when an API key secret is configured.
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["**"]
|
||||
pull_request:
|
||||
branches: ["**"]
|
||||
schedule:
|
||||
- cron: "17 6 * * *" # daily, so the world is exercised even without changes
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
universe:
|
||||
name: Mini universe (mock LLM)
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: stable
|
||||
cache: true
|
||||
- name: Build
|
||||
run: go build ./...
|
||||
- name: Universe end-to-end (asserts; exits non-zero on failure)
|
||||
run: go run ./internal/harness/universe
|
||||
- name: Agent-flow harness
|
||||
run: go run ./internal/harness/agent-flow
|
||||
- name: Plan-delegate harness
|
||||
run: go run ./internal/harness/plan-delegate
|
||||
|
||||
universe-live:
|
||||
name: Mini universe (live LLM, if key present)
|
||||
runs-on: ubuntu-latest
|
||||
# Only on the daily schedule or a manual run — never automatically on
|
||||
# every push/PR, so changes don't quietly burn API credits. Trigger it
|
||||
# by hand (Actions → Universe → Run workflow) when changing the agent,
|
||||
# flow, or AI internals and you want a real-model check.
|
||||
if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: stable
|
||||
cache: true
|
||||
- name: Universe against a live model (AtlasCloud)
|
||||
env:
|
||||
ATLASCLOUD_API_KEY: ${{ secrets.ATLASCLOUD_API_KEY }}
|
||||
run: |
|
||||
if [ -z "$ATLASCLOUD_API_KEY" ]; then
|
||||
echo "No ATLASCLOUD_API_KEY secret configured — skipping the live run."
|
||||
exit 0
|
||||
fi
|
||||
go run ./internal/harness/universe -provider atlascloud
|
||||
+1
-24
@@ -1,11 +1,8 @@
|
||||
# Develop tools
|
||||
/.vscode/
|
||||
/.idea/
|
||||
/.trunk
|
||||
|
||||
# VS Code workspace files (keep settings for consistency)
|
||||
/.vscode/*
|
||||
!/.vscode/settings.json
|
||||
|
||||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
*.exe~
|
||||
@@ -33,7 +30,6 @@ _cgo_export.*
|
||||
|
||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
||||
*.out
|
||||
coverage.html
|
||||
|
||||
# vim temp files
|
||||
*~
|
||||
@@ -43,22 +39,3 @@ coverage.html
|
||||
# go work files
|
||||
go.work
|
||||
go.work.sum
|
||||
|
||||
# Build artifacts
|
||||
dist/
|
||||
bin/
|
||||
|
||||
# Example binaries (go build in examples/)
|
||||
examples/**/server/server
|
||||
examples/**/client/client
|
||||
examples/mcp/documented/documented
|
||||
examples/mcp/hello/hello
|
||||
|
||||
# IDE-specific files
|
||||
.DS_Store
|
||||
/micro
|
||||
|
||||
# Built example/harness binaries (go build ./path/... drops these at repo root)
|
||||
/plan-delegate
|
||||
/agent-plan-delegate
|
||||
/micro-mcp-gateway
|
||||
|
||||
@@ -1,136 +0,0 @@
|
||||
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
|
||||
# vim: set ts=2 sw=2 tw=0 fo=cnqoj
|
||||
|
||||
version: 2
|
||||
|
||||
before:
|
||||
hooks:
|
||||
- go mod tidy
|
||||
|
||||
builds:
|
||||
- main: ./cmd/micro
|
||||
id: micro
|
||||
binary: micro
|
||||
env:
|
||||
- CGO_ENABLED=0
|
||||
- >-
|
||||
{{- if eq .Os "darwin" }}
|
||||
{{- if eq .Arch "amd64"}}CC=o64-clang{{- end }}
|
||||
{{- if eq .Arch "arm64"}}CC=aarch64-apple-darwin20.2-clang{{- end }}
|
||||
{{- end }}
|
||||
{{- if eq .Os "windows" }}
|
||||
{{- if eq .Arch "amd64" }}CC=x86_64-w64-mingw32-gcc{{- end }}
|
||||
{{- end }}
|
||||
goos:
|
||||
- linux
|
||||
- windows
|
||||
- darwin
|
||||
goarch:
|
||||
- amd64
|
||||
- arm
|
||||
- arm64
|
||||
goarm:
|
||||
- 7
|
||||
ignore:
|
||||
- goos: windows
|
||||
goarch: arm
|
||||
|
||||
- main: ./cmd/protoc-gen-micro
|
||||
id: protoc-gen-micro
|
||||
binary: protoc-gen-micro
|
||||
env:
|
||||
- CGO_ENABLED=0
|
||||
- >-
|
||||
{{- if eq .Os "darwin" }}
|
||||
{{- if eq .Arch "amd64"}}CC=o64-clang{{- end }}
|
||||
{{- if eq .Arch "arm64"}}CC=aarch64-apple-darwin20.2-clang{{- end }}
|
||||
{{- end }}
|
||||
{{- if eq .Os "windows" }}
|
||||
{{- if eq .Arch "amd64" }}CC=x86_64-w64-mingw32-gcc{{- end }}
|
||||
{{- end }}
|
||||
goos:
|
||||
- linux
|
||||
- windows
|
||||
- darwin
|
||||
goarch:
|
||||
- amd64
|
||||
- arm
|
||||
- arm64
|
||||
goarm:
|
||||
- 7
|
||||
ignore:
|
||||
- goos: windows
|
||||
goarch: arm
|
||||
|
||||
archives:
|
||||
- id: micro
|
||||
ids:
|
||||
- micro
|
||||
formats: [tar.gz]
|
||||
name_template: >-
|
||||
{{ .Binary }}_
|
||||
{{- .Os }}_
|
||||
{{- .Arch }}
|
||||
{{- if .Arm }}v{{ .Arm }}{{ end }}
|
||||
files:
|
||||
- none*
|
||||
format_overrides:
|
||||
- goos: windows
|
||||
formats: [zip]
|
||||
|
||||
- id: protoc-gen-micro
|
||||
ids:
|
||||
- protoc-gen-micro
|
||||
formats: [tar.gz]
|
||||
name_template: >-
|
||||
{{ .Binary }}_
|
||||
{{- .Os }}_
|
||||
{{- .Arch }}
|
||||
{{- if .Arm }}v{{ .Arm }}{{ end }}
|
||||
files:
|
||||
- none*
|
||||
format_overrides:
|
||||
- goos: windows
|
||||
formats: [zip]
|
||||
|
||||
report_sizes: true
|
||||
|
||||
changelog:
|
||||
sort: asc
|
||||
filters:
|
||||
exclude:
|
||||
- "^docs:"
|
||||
- "^test:"
|
||||
|
||||
dockers_v2:
|
||||
-
|
||||
ids:
|
||||
- micro
|
||||
- protoc-gen-micro
|
||||
images:
|
||||
- "micro/micro"
|
||||
- "ghcr.io/micro/go-micro"
|
||||
tags:
|
||||
- "v{{ .Version }}"
|
||||
- "{{ if .IsNightly }}nightly{{ end }}"
|
||||
- "{{ if not .IsNightly }}latest{{ end }}"
|
||||
labels:
|
||||
"io.artifacthub.package.readme-url": "https://raw.githubusercontent.com/micro/go-micro/refs/heads/master/README.md"
|
||||
"io.artifacthub.package.logo-url": "https://www.gravatar.com/avatar/09d1da3ea9ee61753219a19016d6a672?s=120&r=g&d=404"
|
||||
"org.opencontainers.image.description": "A Go Platform built for Developers"
|
||||
"org.opencontainers.image.created": "{{.Date}}"
|
||||
"org.opencontainers.image.title": "{{.ProjectName}}"
|
||||
"org.opencontainers.image.revision": "{{.FullCommit}}"
|
||||
"org.opencontainers.image.version": "{{.Version}}"
|
||||
"org.opencontainers.image.source": "{{.GitURL}}"
|
||||
"org.opencontainers.image.url": "{{.GitURL}}"
|
||||
"org.opencontainers.image.licenses": "MIT"
|
||||
|
||||
platforms:
|
||||
- linux/amd64
|
||||
- linux/arm64
|
||||
|
||||
retry:
|
||||
attempts: 5
|
||||
delay: 5s
|
||||
max_delay: 2m
|
||||
@@ -0,0 +1,29 @@
|
||||
labelType: long
|
||||
coverThreshold: 70
|
||||
buildStyle:
|
||||
bold: true
|
||||
foreground: yellow
|
||||
startStyle:
|
||||
foreground: lightBlack
|
||||
passStyle:
|
||||
foreground: green
|
||||
failStyle:
|
||||
bold: true
|
||||
foreground: "#821515"
|
||||
skipStyle:
|
||||
foreground: lightBlack
|
||||
passPackageStyle:
|
||||
foreground: green
|
||||
hide: false
|
||||
failPackageStyle:
|
||||
bold: true
|
||||
foreground: "#821515"
|
||||
coveredStyle:
|
||||
foreground: green
|
||||
uncoveredStyle:
|
||||
bold: true
|
||||
foreground: yellow
|
||||
fileStyle:
|
||||
foreground: cyan
|
||||
lineStyle:
|
||||
foreground: magenta
|
||||
Vendored
-137
@@ -1,137 +0,0 @@
|
||||
{
|
||||
"folders": [
|
||||
{
|
||||
"path": "."
|
||||
}
|
||||
],
|
||||
"settings": {
|
||||
"go.toolsManagement.autoUpdate": true,
|
||||
"go.useLanguageServer": true,
|
||||
"go.lintOnSave": "workspace",
|
||||
"go.lintTool": "golangci-lint",
|
||||
"go.lintFlags": [
|
||||
"--fast"
|
||||
],
|
||||
"go.formatTool": "goimports",
|
||||
"go.formatFlags": [],
|
||||
"go.buildOnSave": "workspace",
|
||||
"go.testOnSave": false,
|
||||
"go.coverOnSave": false,
|
||||
"go.testFlags": ["-v", "-race"],
|
||||
"go.testTimeout": "60s",
|
||||
"go.gopath": "",
|
||||
"go.goroot": "",
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.organizeImports": "explicit"
|
||||
},
|
||||
"files.exclude": {
|
||||
"**/.git": true,
|
||||
"**/.DS_Store": true,
|
||||
"**/node_modules": true,
|
||||
"**/*.test": true,
|
||||
"**/coverage.out": true,
|
||||
"**/coverage.html": true
|
||||
},
|
||||
"files.watcherExclude": {
|
||||
"**/.git/objects/**": true,
|
||||
"**/.git/subtree-cache/**": true,
|
||||
"**/node_modules/**": true,
|
||||
"**/.vscode/**": true
|
||||
},
|
||||
"search.exclude": {
|
||||
"**/node_modules": true,
|
||||
"**/bower_components": true,
|
||||
"**/*.code-search": true,
|
||||
"**/vendor": true,
|
||||
"**/.git": true
|
||||
},
|
||||
"[go]": {
|
||||
"editor.tabSize": 4,
|
||||
"editor.insertSpaces": false,
|
||||
"editor.formatOnSave": true,
|
||||
"editor.defaultFormatter": "golang.go"
|
||||
},
|
||||
"[go.mod]": {
|
||||
"editor.formatOnSave": true,
|
||||
"editor.defaultFormatter": "golang.go"
|
||||
},
|
||||
"[markdown]": {
|
||||
"editor.formatOnSave": false,
|
||||
"editor.wordWrap": "on"
|
||||
},
|
||||
"gopls": {
|
||||
"ui.semanticTokens": true,
|
||||
"ui.completion.usePlaceholders": true,
|
||||
"formatting.gofumpt": false,
|
||||
"analyses": {
|
||||
"unusedparams": true,
|
||||
"shadow": true,
|
||||
"fieldalignment": false
|
||||
}
|
||||
}
|
||||
},
|
||||
"extensions": {
|
||||
"recommendations": [
|
||||
"golang.go",
|
||||
"editorconfig.editorconfig",
|
||||
"redhat.vscode-yaml",
|
||||
"ms-vscode.makefile-tools"
|
||||
]
|
||||
},
|
||||
"tasks": {
|
||||
"version": "2.0.0",
|
||||
"tasks": [
|
||||
{
|
||||
"label": "Run Tests",
|
||||
"type": "shell",
|
||||
"command": "make test",
|
||||
"group": {
|
||||
"kind": "test",
|
||||
"isDefault": true
|
||||
},
|
||||
"presentation": {
|
||||
"reveal": "always",
|
||||
"panel": "new"
|
||||
}
|
||||
},
|
||||
{
|
||||
"label": "Run Tests with Coverage",
|
||||
"type": "shell",
|
||||
"command": "make test-coverage",
|
||||
"group": "test"
|
||||
},
|
||||
{
|
||||
"label": "Run Linter",
|
||||
"type": "shell",
|
||||
"command": "make lint",
|
||||
"group": "build"
|
||||
},
|
||||
{
|
||||
"label": "Format Code",
|
||||
"type": "shell",
|
||||
"command": "make fmt",
|
||||
"group": "build"
|
||||
}
|
||||
]
|
||||
},
|
||||
"launch": {
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "Debug Current File",
|
||||
"type": "go",
|
||||
"request": "launch",
|
||||
"mode": "debug",
|
||||
"program": "${file}"
|
||||
},
|
||||
{
|
||||
"name": "Debug Test",
|
||||
"type": "go",
|
||||
"request": "launch",
|
||||
"mode": "test",
|
||||
"program": "${workspaceFolder}"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
-125
@@ -1,125 +0,0 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to Go Micro are documented here.
|
||||
|
||||
Format follows [Keep a Changelog](https://keepachangelog.com/). Go Micro uses
|
||||
calendar-based versions (YYYY.MM) for the AI-native era.
|
||||
|
||||
---
|
||||
|
||||
## [6.0.0] - June 2026
|
||||
|
||||
The AI-native major release. Breaking changes are listed first; everything
|
||||
else is additive. See the [v5 → v6 migration guide](internal/website/docs/guides/migration/v5-to-v6.md) — it's a small upgrade.
|
||||
|
||||
### Changed (breaking)
|
||||
- **Module path is now `go-micro.dev/v6`.** Update imports (`go-micro.dev/v5/...` → `go-micro.dev/v6/...`) and `go install go-micro.dev/v6/cmd/micro@latest`.
|
||||
- **TLS verification is on by default.** v5 skipped verification unless `MICRO_TLS_SECURE=true`; v6 verifies by default. `MICRO_TLS_SECURE` is removed — set `MICRO_TLS_INSECURE=true` (or call `tls.InsecureConfig()`) for self-signed/dev certs.
|
||||
- **`micro.NewService(name, opts...)` is the service constructor**, symmetric with `NewAgent`/`NewFlow`. `micro.New(name, opts...)` remains as a deprecated alias; the old name-less `micro.NewService(opts...)` form is removed (pass the name positionally). Generators emit the new form.
|
||||
- **JWT auth ported in-module.** The external `github.com/micro/plugins/v5/auth/jwt` (pinned to v5) is replaced by `go-micro.dev/v6/auth/jwt/token`, now on the maintained `golang-jwt/jwt/v5`; the deprecated `dgrijalva/jwt-go` dependency is dropped.
|
||||
|
||||
### Added
|
||||
- **A2A protocol — both directions** — `gateway/a2a` exposes registered agents over the open Agent2Agent (A2A) protocol so agents on other frameworks can discover and call them: Agent Cards are generated from registry metadata (the same way the MCP gateway derives tools), and incoming tasks are translated to the agent's existing `Agent.Chat` RPC, with no per-agent code (`micro a2a serve`). The outbound `a2a.Client` calls external A2A agents by URL, wired into `flow.A2A(url)` (a workflow step) and `delegate` to an `http(s)` URL (from inside an agent). An agent can also serve A2A **directly** without a gateway via `AgentA2A(addr)` (`a2a.NewAgentHandler`), handling tasks in-process. v1 is the synchronous JSON-RPC binding (`message/send`, `tasks/get`, card discovery); streaming and push notifications are advertised as unsupported. (`gateway/a2a/`, `cmd/micro/a2a/`)
|
||||
- **Agents (`micro.NewAgent`)** — an agent is a service with an LLM inside: it discovers its assigned services as tools, runs the model's tool loop, registers a `Chat` RPC endpoint, and is reachable like any service. `Ask` for programmatic use; `micro chat` discovers and routes to agents; `micro agent list`/`describe`. (`agent/`)
|
||||
- **Plan & delegate** — two built-in agent tools added to every agent: `plan` (an ordered, store-persisted plan surfaced back in the prompt) and `delegate` (hand a self-contained subtask to a registered agent over RPC, otherwise to an ephemeral sub-agent). No harness or graph — they're plain tools. (`agent/builtin.go`, `examples/agent-plan-delegate/`)
|
||||
- **Agent guardrails** — `MaxSteps` (stop on count), `LoopLimit` (stop repeated no-progress calls; on by default), and `ApproveTool` (human-in-the-loop / policy gate before each action), enforced at the one point every tool call passes through. (`agent/`, guide + blog)
|
||||
- **Pluggable agent memory & custom tools** — durable store-backed conversation memory by default, swappable via `AgentMemory`; register any function as a tool with `AgentTool`.
|
||||
- **Workflows (`micro.NewFlow`)** — event-driven orchestration that maps to Anthropic's workflow/agent split: an event triggers a deterministic step (or ordered durable steps), or dispatches to an agent with `FlowAgent`. (`flow/`)
|
||||
- **x402 payments** — opt-in per-call payments for tools via the x402 standard, with a pluggable facilitator and a consumer-side client + budget; the MCP gateway can advertise and require payment per tool. (`wrapper/x402/`, guide + blog)
|
||||
- **Scoped store state** — `store.Scope(s, database, table)` returns a store handle that confines every operation to a database/table without mutating the shared store (unlike `Init(Table(...))`, which is process-global and races between co-located components). Services, agents, and flows now each keep their state in their own table (`service/{name}`, `agent/{name}`, `flow/{name}`); the service path replaces the old `Init(store.Table(name))` global mutation with a scoped handle.
|
||||
- **Flow discovery & history CLI** — running flows now register in the registry as `type=flow` (and deregister on `Stop`), so they're discoverable like agents: `micro flow list` shows running flows, `micro flow runs <name>` shows a flow's durable run history from the store, and `micro agent history <name>` shows an agent's stored conversation. Live state comes from the registry; durable history from the scoped store.
|
||||
- **Durable workflows** — a flow can now be an ordered list of steps (a task with stages) that is checkpointed before and after each step, so a run survives a crash and resumes where it stopped without re-running completed steps. State carries a typed payload plus a `Stage` marker; flow-level `Retry` with a per-step override; runs retained for audit unless `DeleteOnSuccess`. Step actions: `Call` (RPC), `LLM` (model turn), `Dispatch` (to an agent), or any `StepFunc`. Durability is a pluggable `Checkpoint` (store-backed by default; implement the interface for Temporal/Restate). Runnable example: `examples/flow-durable/`. Blog: "Durable Workflows" (`internal/website/blog/24.md`).
|
||||
- **Agent tool-execution wrappers** — `AgentWrapTool` registers middleware around an agent's tool calls, the tool-side analogue of `client.CallWrapper`/`server.HandlerWrapper`. Use it for logging, metrics, retries, or policy; wrappers compose outermost-first and run outside the built-in guardrails. Includes a runnable example with observe + retry wrappers (`examples/agent-wrap-tool/`).
|
||||
- **Agent platform showcase** — full platform example (Users, Posts, Comments, Mail) mirroring [micro/blog](https://github.com/micro/blog), demonstrating how existing microservices become agent-accessible with zero code changes (`examples/mcp/platform/`).
|
||||
- **Blog post: "Your Microservices Are Already an AI Platform"** — walkthrough of agent-service interaction patterns using real-world services (`internal/website/blog/7.md`).
|
||||
- **Circuit breakers for MCP gateway** — per-tool circuit breakers protect downstream services from cascading failures. Configurable max failures, open-state timeout, and half-open probing. Available via `Options.CircuitBreaker` and `--circuit-breaker` CLI flag (`gateway/mcp/circuitbreaker.go`).
|
||||
- **Helm chart for MCP gateway** — official Helm chart at `deploy/helm/mcp-gateway/` with Deployment, Service, ServiceAccount, HPA, and Ingress templates. Supports Consul/etcd/mDNS registries, JWT auth, rate limiting, audit logging, per-tool scopes, TLS ingress, and auto-scaling.
|
||||
- **MCP gateway benchmarks** — comprehensive benchmark suite for tool listing, lookup, auth, rate limiting, and JSON serialization (`gateway/mcp/benchmark_test.go`)
|
||||
- **Workflow example** — cross-service orchestration demo with Inventory, Orders, and Notifications services showing agents chaining multi-step workflows from natural language (`examples/mcp/workflow/`)
|
||||
- **Docker Compose deployment** — production-like setup with Consul registry, standalone MCP gateway, and Jaeger tracing in one `docker-compose up` (`examples/deployment/`)
|
||||
|
||||
---
|
||||
|
||||
## [2026.03] - March 2026
|
||||
|
||||
### Added
|
||||
|
||||
#### Developer Experience
|
||||
- **`micro new` MCP templates** — `micro new myservice` generates MCP-enabled services with doc comments, `@example` tags, and `WithMCP()` wired in. Use `--no-mcp` to opt out.
|
||||
- **`micro.NewService("name")` unified API** — single way to create services: `micro.NewService("greeter")` or `micro.NewService("greeter", micro.Address(":8080"))`. Replaces `micro.NewService()` + `service.New()` dual API.
|
||||
- **`service.Handle()` simplified registration** — register handlers with `service.Handle(new(Greeter))` instead of manual `server.NewHandler` + `server.Handle`.
|
||||
- **`micro.NewGroup()` modular monoliths** — run multiple services in one binary with shared lifecycle: `micro.NewGroup(users, orders).Run()`.
|
||||
- **`mcp.WithMCP()` one-liner** — add MCP to any service with a single option: `micro.NewService("name", mcp.WithMCP(":3001"))`.
|
||||
- **CRUD example** — contact book service with 6 operations, rich agent docs, and validation patterns (`examples/mcp/crud/`).
|
||||
|
||||
#### MCP Gateway
|
||||
- **WebSocket transport** — bidirectional JSON-RPC 2.0 streaming over WebSocket for real-time agent communication (`gateway/mcp/websocket.go`).
|
||||
- **OpenTelemetry integration** — full span instrumentation across HTTP, stdio, and WebSocket transports with W3C trace context propagation (`gateway/mcp/otel.go`).
|
||||
- **Standalone gateway binary** — `micro-mcp-gateway` with Docker support for running the MCP gateway independently of services.
|
||||
- **Per-tool auth scopes** — service-level (`server.WithEndpointScopes()`) and gateway-level (`Options.Scopes`) scope enforcement with bearer token auth.
|
||||
- **Rate limiting** — per-tool token bucket rate limiting (`Options.RateLimit`).
|
||||
- **Audit logging** — immutable audit records per tool call with trace ID, account, scopes, duration, and errors (`Options.AuditFunc`).
|
||||
|
||||
#### AI Model Package
|
||||
- **`model.Model` interface** — unified AI provider abstraction with `Generate()` and `Stream()` methods.
|
||||
- **Anthropic Claude provider** — `model/anthropic` with tool execution and auto-calling.
|
||||
- **OpenAI GPT provider** — `model/openai` with provider auto-detection from base URL.
|
||||
|
||||
#### Agent SDKs
|
||||
- **LangChain SDK** — `contrib/langchain-go-micro/` Python package with auto-discovery, tool generation, and multi-agent workflow examples.
|
||||
- **LlamaIndex SDK** — `contrib/go-micro-llamaindex/` Python package with RAG integration examples.
|
||||
|
||||
#### Documentation
|
||||
- **AI-native services guide** — building services for AI agents from scratch
|
||||
- **MCP security guide** — auth, scopes, and audit logging
|
||||
- **Tool descriptions guide** — writing doc comments that improve agent performance
|
||||
- **Agent patterns guide** — architecture patterns for agent integration
|
||||
- **Error handling guide** — writing agent-friendly error responses with typed errors
|
||||
- **Troubleshooting guide** — common MCP issues and solutions
|
||||
- **Migration guide** — add MCP to existing services in 5 minutes
|
||||
|
||||
#### CLI
|
||||
- **`micro mcp serve`** — start MCP server (stdio for Claude Code, HTTP for web agents)
|
||||
- **`micro mcp list`** — list available tools (human-readable or JSON)
|
||||
- **`micro mcp test`** — test tools with JSON input
|
||||
- **`micro mcp docs`** — generate tool documentation
|
||||
- **`micro mcp export`** — export to LangChain, OpenAPI, or JSON formats
|
||||
|
||||
#### Agent Playground
|
||||
- **Chat-focused UI** — redesigned playground with collapsible tool calls, real-time status, and thinking indicators
|
||||
- **Provider settings** — configurable OpenAI/Anthropic provider, model, and API key
|
||||
|
||||
### Changed
|
||||
- Service interface moved to `service.Service` with `micro.Service` as a type alias for backward compatibility.
|
||||
- `service.New()` returns `service.Service` interface (was `*ServiceImpl`).
|
||||
- `service.NewGroup()` accepts `service.Service` interface (was `*ServiceImpl`).
|
||||
- `go.mod` template in `micro new` updated to Go 1.22.
|
||||
|
||||
### Fixed
|
||||
- Handler `Handle()` method accepts variadic `server.HandlerOption` for scopes and metadata.
|
||||
- Store initialization uses service name as table automatically.
|
||||
- Service `Stop()` properly aggregates errors from lifecycle hooks.
|
||||
|
||||
---
|
||||
|
||||
## [2026.02] - February 2026
|
||||
|
||||
### Added
|
||||
- **MCP gateway library** — `gateway/mcp/` with HTTP/SSE and stdio transports, service discovery, tool generation, and JSON schema generation from Go types (2,500+ lines).
|
||||
- **CLI integration** — `micro run --mcp-address` flag to start MCP alongside services.
|
||||
- **Documentation extraction** — auto-extract tool descriptions from Go doc comments with `@example` tag and struct tag parsing.
|
||||
- **Blog post** — "Making Microservices AI-Native with MCP"
|
||||
- **MCP examples** — `examples/mcp/hello/` and `examples/mcp/documented/`
|
||||
|
||||
---
|
||||
|
||||
## [2026.01] - January 2026
|
||||
|
||||
### Added
|
||||
- **`micro deploy`** — deploy services to any Linux server via SSH + systemd with `micro deploy user@server`.
|
||||
- **`micro build`** — build Go binaries and Docker images with `micro build --docker`.
|
||||
- **Blog post** — "Introducing micro deploy"
|
||||
|
||||
---
|
||||
|
||||
_For earlier changes, see the [git log](https://github.com/micro/go-micro/commits/master)._
|
||||
@@ -1,148 +0,0 @@
|
||||
# CLAUDE.md - Go Micro Project Guide
|
||||
|
||||
## Project Overview
|
||||
|
||||
Go Micro is a framework for distributed systems development in Go. It provides pluggable abstractions for service discovery, RPC, pub/sub, config, auth, storage, and more.
|
||||
|
||||
The framework is evolving into an **AI-native platform** where every microservice is automatically accessible to AI agents via the Model Context Protocol (MCP).
|
||||
|
||||
## Build & Test
|
||||
|
||||
```bash
|
||||
# Run all tests
|
||||
make test
|
||||
|
||||
# Run tests for a specific package
|
||||
go test ./gateway/mcp/...
|
||||
go test ./ai/...
|
||||
go test ./model/...
|
||||
|
||||
# Lint
|
||||
make lint
|
||||
|
||||
# Format
|
||||
make fmt
|
||||
|
||||
# Build CLI
|
||||
go build -o micro ./cmd/micro
|
||||
|
||||
# Run locally with hot reload
|
||||
micro run
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
go-micro/
|
||||
├── agent/ # Agent abstraction (intelligent service management)
|
||||
├── ai/ # AI model providers (Anthropic, OpenAI, Gemini, etc.)
|
||||
├── auth/ # Authentication (JWT, no-op)
|
||||
├── broker/ # Message broker (NATS, RabbitMQ)
|
||||
├── cache/ # Caching (Redis)
|
||||
├── client/ # RPC client (gRPC)
|
||||
├── cmd/micro/ # CLI tool (run, deploy, mcp, build, server)
|
||||
├── codec/ # Message codecs (JSON, Proto)
|
||||
├── config/ # Dynamic config (env, file, etcd, NATS)
|
||||
├── errors/ # Error handling
|
||||
├── events/ # Event system (NATS JetStream)
|
||||
├── flow/ # Event-driven LLM orchestration
|
||||
├── gateway/
|
||||
│ ├── api/ # REST API gateway
|
||||
│ └── mcp/ # MCP gateway (core AI integration)
|
||||
│ └── deploy/ # Helm charts for MCP gateway
|
||||
├── health/ # Health checking
|
||||
├── logger/ # Logging
|
||||
├── metadata/ # Context metadata
|
||||
├── model/ # Typed data models (CRUD, queries, schemas)
|
||||
├── registry/ # Service discovery (mDNS, Consul, etcd)
|
||||
├── selector/ # Client-side load balancing
|
||||
├── server/ # RPC server
|
||||
├── service/ # Service interface + profiles
|
||||
├── store/ # Data persistence (Postgres, NATS KV)
|
||||
├── transport/ # Network transport
|
||||
├── wrapper/ # Middleware (auth, trace, metrics)
|
||||
├── examples/ # Working examples
|
||||
└── internal/ # Non-public: docs, utils, test harness
|
||||
```
|
||||
|
||||
## Key Architectural Decisions
|
||||
|
||||
- **Plugin architecture**: All abstractions use Go interfaces. Defaults work out of the box, everything is swappable.
|
||||
- **Progressive complexity**: Zero-config for development, full control for production.
|
||||
- **AI-native by default**: Every service is automatically an MCP tool. No extra code needed.
|
||||
- **In-repo plugins**: Plugins live in the main repo to avoid version compatibility issues.
|
||||
- **Reflection-based registration**: Handlers are registered via reflection for minimal boilerplate.
|
||||
|
||||
## Code Conventions
|
||||
|
||||
- Standard Go conventions (gofmt, golint)
|
||||
- Functional options pattern for configuration (`WithX()` functions)
|
||||
- Interface-first design: define the interface, then implement
|
||||
- Tests alongside code (not in separate test directories)
|
||||
- Commit messages: imperative mood, concise summary line
|
||||
|
||||
## Current Focus & Priorities (March 2026)
|
||||
|
||||
### Status
|
||||
- **Q1 2026 (MCP Foundation):** COMPLETE
|
||||
- **Q2 2026 (Agent DX):** COMPLETE (100%)
|
||||
- **Q3 2026 (Production):** 50% complete (ahead of schedule)
|
||||
|
||||
### Priority 1: Agent Showcase & Examples
|
||||
Build compelling demos showing agents interacting with go-micro services in realistic scenarios.
|
||||
|
||||
### Priority 2: Additional Protocol Support
|
||||
- gRPC reflection-based MCP
|
||||
- HTTP/3 support
|
||||
|
||||
### Priority 3: Kubernetes & Deployment
|
||||
- Helm Charts for MCP gateway
|
||||
- Kubernetes Operator with CRDs
|
||||
|
||||
### Recently Completed
|
||||
- **Agent Plan & Delegate** - Two built-in agent tools: `plan` (ordered plan persisted to store-backed memory, surfaced in the prompt) and `delegate` (hand a subtask to another agent — RPC to a registered agent, else an ephemeral sub-agent with isolated context). Added automatically to every agent; no harness or graph. (`agent/builtin.go`, `examples/agent-plan-delegate/`)
|
||||
- **`micro new` MCP Templates** - Scaffolds MCP-enabled services with doc comments, `@example` tags, `WithMCP()`. `--no-mcp` to opt out.
|
||||
- **CRUD Example** - Contact book service with 6 operations, rich agent docs (`examples/mcp/crud/`)
|
||||
- **Migration Guide** - "Add MCP to Existing Services" guide with 3 approaches
|
||||
- **Troubleshooting Guide** - Common MCP issues and solutions
|
||||
- **Error Handling Guide** - Patterns for agent-friendly error responses
|
||||
- **Documentation Guides** - Six guides: AI-native services, MCP security, tool descriptions, agent patterns, error handling, troubleshooting
|
||||
- **WithMCP Option** - One-line MCP setup (`gateway/mcp/option.go`)
|
||||
- **Agent Playground Redesign** - Chat-focused UI with collapsible tool calls
|
||||
- **Standalone Gateway Binary** - `micro-mcp-gateway` with Docker support
|
||||
- **WebSocket Transport** - Bidirectional JSON-RPC 2.0 streaming (`gateway/mcp/websocket.go`)
|
||||
- **OpenTelemetry Integration** - Full span instrumentation with W3C trace context (`gateway/mcp/otel.go`)
|
||||
- **LlamaIndex SDK** - Python package with RAG examples (`contrib/go-micro-llamaindex/`)
|
||||
|
||||
## Key Files
|
||||
|
||||
| Purpose | File |
|
||||
|---------|------|
|
||||
| MCP Gateway | `gateway/mcp/mcp.go` |
|
||||
| MCP Docs | `gateway/mcp/DOCUMENTATION.md` |
|
||||
| AI Interface | `ai/model.go` |
|
||||
| Model Layer | `model/model.go` |
|
||||
| CLI Entry | `cmd/micro/main.go` |
|
||||
| MCP CLI | `cmd/micro/mcp/` |
|
||||
| Server (run/server) | `cmd/micro/server/server.go` |
|
||||
| Roadmap | `internal/docs/ROADMAP_2026.md` |
|
||||
| Status | `internal/docs/CURRENT_STATUS_SUMMARY.md` |
|
||||
| Changelog | `CHANGELOG.md` |
|
||||
| Docs Site | `internal/website/docs/` |
|
||||
|
||||
## Roadmap & Status Documents
|
||||
|
||||
- **[ROADMAP.md](ROADMAP.md)** - General framework roadmap
|
||||
- **[internal/docs/ROADMAP_2026.md](internal/docs/ROADMAP_2026.md)** - AI-native era roadmap with business model
|
||||
- **[internal/docs/CURRENT_STATUS_SUMMARY.md](internal/docs/CURRENT_STATUS_SUMMARY.md)** - Quick status overview
|
||||
- **[internal/docs/PROJECT_STATUS_2026.md](internal/docs/PROJECT_STATUS_2026.md)** - Detailed technical status
|
||||
- **[internal/docs/IMPLEMENTATION_SUMMARY.md](internal/docs/IMPLEMENTATION_SUMMARY.md)** - Implementation notes
|
||||
- **[CHANGELOG.md](CHANGELOG.md)** - What changed and when
|
||||
|
||||
## Contributing
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for full guidelines. Key points:
|
||||
- Open an issue before large changes
|
||||
- Include tests for new features
|
||||
- Run `make test` and `make lint` before submitting
|
||||
- Follow commit message format: `type: description` (e.g., `feat: add WebSocket transport`)
|
||||
+5
-17
@@ -19,24 +19,16 @@ Be respectful, inclusive, and collaborative. We're all here to build great softw
|
||||
# Install dependencies
|
||||
go mod download
|
||||
|
||||
# Install development tools
|
||||
make install-tools
|
||||
|
||||
# Run tests
|
||||
make test
|
||||
go test ./...
|
||||
|
||||
# Run tests with race detector and coverage
|
||||
make test-coverage
|
||||
# Run tests with coverage
|
||||
go test -race -coverprofile=coverage.out ./...
|
||||
|
||||
# Run linter
|
||||
make lint
|
||||
|
||||
# Format code
|
||||
make fmt
|
||||
# Run linter (install golangci-lint first)
|
||||
golangci-lint run
|
||||
```
|
||||
|
||||
See `make help` for all available commands.
|
||||
|
||||
## Making Changes
|
||||
|
||||
### Code Guidelines
|
||||
@@ -91,10 +83,6 @@ go test -v ./...
|
||||
|
||||
# Run specific test
|
||||
go test -run TestMyFunction ./pkg/...
|
||||
|
||||
# Optional: Use richgo for colored output
|
||||
go install github.com/kyoh86/richgo@latest
|
||||
richgo test -v ./...
|
||||
```
|
||||
|
||||
### Documentation
|
||||
|
||||
-26
@@ -1,26 +0,0 @@
|
||||
FROM alpine:latest
|
||||
ARG TARGETPLATFORM
|
||||
ENV USER=micro
|
||||
ENV GROUPNAME=$USER
|
||||
ARG UID=1001
|
||||
ARG GID=1001
|
||||
RUN addgroup --gid "$GID" "$GROUPNAME" \
|
||||
&& adduser \
|
||||
--disabled-password \
|
||||
--gecos "" \
|
||||
--home "/micro" \
|
||||
--ingroup "$GROUPNAME" \
|
||||
--no-create-home \
|
||||
--uid "$UID" "$USER"
|
||||
|
||||
ENV PATH=/usr/local/go/bin:$PATH
|
||||
RUN apk --no-cache add git make curl
|
||||
COPY --from=golang:1.26.0-alpine /usr/local/go /usr/local/go
|
||||
|
||||
COPY $TARGETPLATFORM/micro /usr/local/go/bin/
|
||||
COPY $TARGETPLATFORM/protoc-gen-micro /usr/local/go/bin/
|
||||
|
||||
WORKDIR /micro
|
||||
EXPOSE 8080
|
||||
ENTRYPOINT ["/usr/local/go/bin/micro"]
|
||||
CMD ["server"]
|
||||
@@ -1,89 +0,0 @@
|
||||
NAME = micro
|
||||
GIT_COMMIT = $(shell git rev-parse --short HEAD)
|
||||
GIT_TAG = $(shell git describe --abbrev=0 --tags --always --match "v*")
|
||||
GIT_IMPORT = go-micro.dev/v5/cmd/micro
|
||||
BUILD_DATE = $(shell date +%s)
|
||||
LDFLAGS = -X $(GIT_IMPORT).BuildDate=$(BUILD_DATE) -X $(GIT_IMPORT).GitCommit=$(GIT_COMMIT) -X $(GIT_IMPORT).GitTag=$(GIT_TAG)
|
||||
|
||||
# GORELEASER_DOCKER_IMAGE = ghcr.io/goreleaser/goreleaser-cross:v1.25.7
|
||||
GORELEASER_DOCKER_IMAGE = ghcr.io/goreleaser/goreleaser:latest
|
||||
|
||||
.PHONY: test test-race test-coverage harness lint fmt install-tools proto clean help gorelease-dry-run gorelease-dry-run-docker
|
||||
|
||||
# Default target
|
||||
help:
|
||||
@echo "Go Micro Development Tasks"
|
||||
@echo ""
|
||||
@echo " make test - Run tests"
|
||||
@echo " make test-race - Run tests with race detector"
|
||||
@echo " make test-coverage - Run tests with coverage"
|
||||
@echo " make lint - Run linter"
|
||||
@echo " make fmt - Format code"
|
||||
@echo " make install-tools - Install development tools"
|
||||
@echo " make proto - Generate protobuf code"
|
||||
@echo " make clean - Clean build artifacts"
|
||||
|
||||
$(NAME):
|
||||
CGO_ENABLED=0 go build -ldflags "-s -w ${LDFLAGS}" -o $(NAME) cmd/micro/main.go
|
||||
|
||||
# Run tests
|
||||
test:
|
||||
go test -v ./...
|
||||
|
||||
# Run tests with race detector
|
||||
test-race:
|
||||
go test -v -race ./...
|
||||
|
||||
# Run tests with coverage
|
||||
test-coverage:
|
||||
go test -v -race -coverprofile=coverage.out -covermode=atomic ./...
|
||||
go tool cover -html=coverage.out -o coverage.html
|
||||
@echo "Coverage report: coverage.html"
|
||||
|
||||
# Run the end-to-end harnesses (deterministic, mock LLM — no API key).
|
||||
# The universe harness exits non-zero on assertion failure.
|
||||
harness:
|
||||
go run ./internal/harness/universe
|
||||
go run ./internal/harness/agent-flow
|
||||
go run ./internal/harness/plan-delegate
|
||||
|
||||
# Run linter
|
||||
lint:
|
||||
golangci-lint run
|
||||
|
||||
# Format code
|
||||
fmt:
|
||||
gofmt -s -w .
|
||||
goimports -w .
|
||||
|
||||
# Install development tools
|
||||
install-tools:
|
||||
@echo "Installing development tools..."
|
||||
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
|
||||
go install golang.org/x/tools/cmd/goimports@latest
|
||||
go install github.com/kyoh86/richgo@latest
|
||||
go install go-micro.dev/v5/cmd/protoc-gen-micro@latest
|
||||
@echo "Tools installed successfully"
|
||||
|
||||
# Generate protobuf code
|
||||
proto:
|
||||
@echo "Generating protobuf code..."
|
||||
find . -name "*.proto" -not -path "./vendor/*" -exec protoc --proto_path=. --micro_out=. --go_out=. {} \;
|
||||
|
||||
# Clean build artifacts
|
||||
clean:
|
||||
rm -f coverage.out coverage.html
|
||||
find . -name "*.test" -type f -delete
|
||||
go clean -cache -testcache
|
||||
|
||||
# Try binary release
|
||||
gorelease-dry-run:
|
||||
docker run \
|
||||
--rm \
|
||||
-e CGO_ENABLED=0 \
|
||||
-v $(CURDIR):/$(NAME) \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-w /$(NAME) \
|
||||
$(GORELEASER_DOCKER_IMAGE) \
|
||||
--clean --verbose --skip=publish,validate --snapshot
|
||||
|
||||
@@ -1,402 +1,226 @@
|
||||
# Go Micro [](https://pkg.go.dev/go-micro.dev/v6?tab=doc) [](https://goreportcard.com/report/github.com/go-micro/go-micro)
|
||||
# Go Micro [](https://pkg.go.dev/go-micro.dev/v5?tab=doc) [](https://goreportcard.com/report/github.com/go-micro/go-micro)
|
||||
|
||||
Go Micro is a framework for building agents and services in Go.
|
||||
Go Micro is a framework for distributed systems development.
|
||||
|
||||
Build an agent and it gets a model, memory, and tools, manages your services, and is reachable over [MCP](https://modelcontextprotocol.io/) and [A2A](https://a2a-protocol.org). Write services and they register, discover each other, and every endpoint is automatically an AI-callable tool. Orchestrate the deterministic parts with flows. Agents, services, and flows are all Go code — the same primitives, the same deployment — because an agent is a distributed system, and building one is building a service.
|
||||
**[📖 Documentation](https://go-micro.dev/docs/)** | [Sponsor the project](https://github.com/sponsors/micro)
|
||||
|
||||
## Sponsors
|
||||
## Overview
|
||||
|
||||
<a href="https://go-micro.dev/blog/3"><img src="https://upload.wikimedia.org/wikipedia/commons/7/78/Anthropic_logo.svg" height="26" /></a>
|
||||
|
||||
<a href="https://go-micro.dev/blog/8"><img src="https://www.atlascloud.ai/logo.svg" height="26" /></a>
|
||||
Go Micro provides the core requirements for distributed systems development including RPC and Event driven communication.
|
||||
The Go Micro philosophy is sane defaults with a pluggable architecture. We provide defaults to get you started quickly
|
||||
but everything can be easily swapped out.
|
||||
|
||||
**Want to support Go Micro and see your logo here?** [Become a sponsor](https://discord.gg/WeMU5AGxD) — reach out on Discord.
|
||||
## Features
|
||||
|
||||
## Contents
|
||||
Go Micro abstracts away the details of distributed systems. Here are the main features.
|
||||
|
||||
- [Quick Start](#quick-start)
|
||||
- [Writing Services](#writing-services)
|
||||
- [Building Agents](#building-agents) — [Plan & Delegate](#plan--delegate), [Pluggable](#batteries-included-pluggable), [Paid tools (x402)](#paid-tools-x402), [A2A](#reachable-by-other-agents-a2a)
|
||||
- [Features](#features)
|
||||
- [CLI](#cli)
|
||||
- [Multi-Service Projects](#multi-service-projects)
|
||||
- [Data Model](#data-model)
|
||||
- [AI Providers](#ai-providers)
|
||||
- [Examples](#examples)
|
||||
- [Docs](#docs)
|
||||
- **Authentication** - Auth is built in as a first class citizen. Authentication and authorization enable secure
|
||||
zero trust networking by providing every service an identity and certificates. This additionally includes rule
|
||||
based access control.
|
||||
|
||||
## Quick Start
|
||||
- **Dynamic Config** - Load and hot reload dynamic config from anywhere. The config interface provides a way to load application
|
||||
level config from any source such as env vars, file, etcd. You can merge the sources and even define fallbacks.
|
||||
|
||||
Install the CLI:
|
||||
- **Data Storage** - A simple data store interface to read, write and delete records. It includes support for many storage backends
|
||||
in the plugins repo. State and persistence becomes a core requirement beyond prototyping and Micro looks to build that into the framework.
|
||||
|
||||
- **Service Discovery** - Automatic service registration and name resolution. Service discovery is at the core of micro service
|
||||
development. When service A needs to speak to service B it needs the location of that service. The default discovery mechanism is
|
||||
multicast DNS (mdns), a zeroconf system.
|
||||
|
||||
- **Load Balancing** - Client side load balancing built on service discovery. Once we have the addresses of any number of instances
|
||||
of a service we now need a way to decide which node to route to. We use random hashed load balancing to provide even distribution
|
||||
across the services and retry a different node if there's a problem.
|
||||
|
||||
- **Message Encoding** - Dynamic message encoding based on content-type. The client and server will use codecs along with content-type
|
||||
to seamlessly encode and decode Go types for you. Any variety of messages could be encoded and sent from different clients. The client
|
||||
and server handle this by default. This includes protobuf and json by default.
|
||||
|
||||
- **RPC Client/Server** - RPC based request/response with support for bidirectional streaming. We provide an abstraction for synchronous
|
||||
communication. A request made to a service will be automatically resolved, load balanced, dialled and streamed.
|
||||
|
||||
- **Async Messaging** - PubSub is built in as a first class citizen for asynchronous communication and event driven architectures.
|
||||
Event notifications are a core pattern in micro service development. The default messaging system is a HTTP event message broker.
|
||||
|
||||
- **Pluggable Interfaces** - Go Micro makes use of Go interfaces for each distributed system abstraction. Because of this these interfaces
|
||||
are pluggable and allows Go Micro to be runtime agnostic. You can plugin any underlying technology.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To make use of Go Micro
|
||||
|
||||
```bash
|
||||
# Binary (no Go required)
|
||||
curl -fsSL https://go-micro.dev/install.sh | sh
|
||||
|
||||
# Or with Go
|
||||
go install go-micro.dev/v6/cmd/micro@latest
|
||||
go get go-micro.dev/v5@latest
|
||||
```
|
||||
|
||||
### Fastest start — no API key
|
||||
|
||||
Scaffold a service, run it, call it:
|
||||
|
||||
```bash
|
||||
micro new helloworld
|
||||
cd helloworld
|
||||
micro run
|
||||
```
|
||||
|
||||
Then in another terminal:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:8080/api/helloworld/Helloworld.Call \
|
||||
-H 'Content-Type: application/json' -d '{"name":"World"}'
|
||||
```
|
||||
|
||||
### Generate from a prompt — with an LLM key
|
||||
|
||||
Set a provider key, describe what you want, and the AI designs services, writes handlers, compiles, and starts them:
|
||||
|
||||
```bash
|
||||
export ANTHROPIC_API_KEY=sk-ant-... # or OPENAI_API_KEY, GEMINI_API_KEY, ...
|
||||
micro run --prompt "a task management system with categories" --provider anthropic
|
||||
```
|
||||
|
||||
The AI designs the architecture, you review it, then it generates handlers with real business logic, compiles them, and starts them:
|
||||
|
||||
```
|
||||
Services:
|
||||
● task — Task management with status tracking
|
||||
● project — Project organization
|
||||
|
||||
Generate? [Y/n]
|
||||
|
||||
Micro
|
||||
Services:
|
||||
● task
|
||||
● project
|
||||
Agents:
|
||||
◆ agent
|
||||
```
|
||||
|
||||
Then talk to your services from the console:
|
||||
|
||||
```
|
||||
> Create a project called Launch, then add three tasks to it
|
||||
|
||||
→ project_Project_Create({"name":"Launch"})
|
||||
← {"record":{"id":"p1..."},"success":true}
|
||||
→ task_Task_Create({"title":"Design specs","project_id":"p1..."})
|
||||
→ task_Task_Create({"title":"Write code","project_id":"p1..."})
|
||||
→ task_Task_Create({"title":"Ship it","project_id":"p1..."})
|
||||
|
||||
Created Work category and added 'Finish report' task to it.
|
||||
```
|
||||
|
||||
When you need a capability that doesn't exist, the agent generates a new service mid-conversation:
|
||||
|
||||
```
|
||||
> I need to track shipping. Create a shipment for order 123 to London.
|
||||
|
||||
⚡ generating shipping service...
|
||||
✓ shipping
|
||||
→ shipping_Shipping_Create({"order_id":"123","destination":"London"})
|
||||
← {"record":{"id":"xyz...","status":"pending"}}
|
||||
|
||||
Created shipment for order 123 going to London.
|
||||
```
|
||||
|
||||
Edit the generated code by hand at any time — re-running preserves your changes. [Read more](https://go-micro.dev/blog/13).
|
||||
|
||||
## Writing Services
|
||||
|
||||
Under the hood, a service is a struct with methods. Doc comments and `@example` tags become tool descriptions for AI agents automatically.
|
||||
Create a service and register a handler
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"go-micro.dev/v6"
|
||||
"go-micro.dev/v5"
|
||||
)
|
||||
|
||||
type Request struct {
|
||||
Name string `json:"name"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
type Response struct {
|
||||
Message string `json:"message"`
|
||||
Message string `json:"message"`
|
||||
}
|
||||
|
||||
type Say struct{}
|
||||
|
||||
// Hello greets a person by name.
|
||||
// @example {"name": "Alice"}
|
||||
func (h *Say) Hello(ctx context.Context, req *Request, rsp *Response) error {
|
||||
rsp.Message = "Hello " + req.Name
|
||||
return nil
|
||||
rsp.Message = "Hello " + req.Name
|
||||
return nil
|
||||
}
|
||||
|
||||
func main() {
|
||||
service := micro.NewService("greeter")
|
||||
service.Handle(new(Say))
|
||||
service.Run()
|
||||
// create the service
|
||||
service := micro.New("helloworld")
|
||||
|
||||
// register handler
|
||||
service.Handle(new(Say))
|
||||
|
||||
// run the service
|
||||
service.Run()
|
||||
}
|
||||
```
|
||||
|
||||
Run it and everything is accessible — REST, gRPC, MCP, agent playground:
|
||||
|
||||
```bash
|
||||
micro run
|
||||
# Dashboard: http://localhost:8080
|
||||
# API: http://localhost:8080/api/{service}/{method}
|
||||
# Agent: http://localhost:8080/agent
|
||||
# MCP Tools: http://localhost:8080/mcp/tools
|
||||
```
|
||||
|
||||
You can also scaffold a service from a template:
|
||||
|
||||
```bash
|
||||
micro new helloworld
|
||||
micro new contacts --template crud
|
||||
```
|
||||
|
||||
## Building Agents
|
||||
|
||||
An Agent is a service with an LLM inside it. It has a proto-defined `Agent.Chat` RPC endpoint, registers in the registry, and is callable like any service:
|
||||
Set a fixed address
|
||||
|
||||
```go
|
||||
agent := micro.NewAgent("task-mgr",
|
||||
micro.AgentServices("task", "project"),
|
||||
micro.AgentPrompt("You manage tasks and projects. You understand deadlines and priorities."),
|
||||
micro.AgentProvider("anthropic"),
|
||||
)
|
||||
agent.Run()
|
||||
```
|
||||
|
||||
The agent discovers its services from the registry, scopes its tools to their endpoints, and maintains conversation memory in the store. It registers itself so `micro chat` and other agents can find it.
|
||||
|
||||
```go
|
||||
// Programmatic interaction
|
||||
resp, _ := agent.Ask(ctx, "What tasks are overdue?")
|
||||
fmt.Println(resp.Reply)
|
||||
```
|
||||
|
||||
Multiple agents coordinate via RPC — each is a service with an `Agent.Chat` endpoint. `micro chat` routes to the right one.
|
||||
|
||||
```bash
|
||||
micro agent list # list registered agents
|
||||
micro call task-mgr Agent.Chat '{"message": "What tasks are overdue?"}'
|
||||
```
|
||||
|
||||
### Plan & Delegate
|
||||
|
||||
Every agent gets two built-in capabilities, exposed as tools — no extra setup, no harness:
|
||||
|
||||
- **`plan`** — for multi-step work, the agent records an ordered plan in its store-backed memory and stays oriented across turns.
|
||||
- **`delegate`** — the agent hands a self-contained subtask to another agent. If a registered agent already owns the relevant services, the hand-off goes over RPC to that agent; otherwise a focused, short-lived sub-agent is created for the subtask with its own isolated context.
|
||||
|
||||
This keeps intelligence distributed: an agent doesn't need to know *how* to do everything, only *who* does. See [examples/agent-plan-delegate](examples/agent-plan-delegate/).
|
||||
|
||||
```go
|
||||
// A sub-agent is just an agent — created with New, talked to with Ask.
|
||||
// delegate-first: reuse a registered agent, or spin up a focused one.
|
||||
resp, _ := agent.Ask(ctx, "Plan the launch, create the tasks, and have comms notify the owner.")
|
||||
```
|
||||
|
||||
### Batteries included, pluggable
|
||||
|
||||
Just as a service composes pluggable abstractions (registry, broker, store), an agent composes a **model**, **memory**, and **tools** — sane defaults out of the box, each swappable.
|
||||
|
||||
```go
|
||||
agent := micro.NewAgent("assistant",
|
||||
micro.AgentProvider("anthropic"), // model — swap the provider
|
||||
micro.AgentMemory(micro.NewInMemory(50)), // memory — default is store-backed & durable
|
||||
micro.AgentTool("weather", "Get the weather for a city",
|
||||
map[string]any{"city": map[string]any{"type": "string"}},
|
||||
func(ctx context.Context, in map[string]any) (string, error) {
|
||||
return getWeather(in["city"].(string)) // tools beyond your services — any function
|
||||
}),
|
||||
micro.AgentMaxSteps(8), // guardrails
|
||||
service := micro.NewService(
|
||||
micro.Name("helloworld"),
|
||||
micro.Address(":8080"),
|
||||
)
|
||||
```
|
||||
|
||||
**Memory** is durable and store-backed by default (Postgres, NATS KV, or file), so an agent picks up where it left off after a restart — or supply your own with `AgentMemory`. **Tools** are your services automatically, plus any function you register with `AgentTool`.
|
||||
|
||||
### Paid tools (x402)
|
||||
|
||||
Every endpoint is an AI-callable tool — and it can be a *paid* tool. Go Micro supports [x402](https://x402.org), the HTTP 402 payment standard for agents, so a tool can require a stablecoin payment and an agent can settle it autonomously. It's opt-in and carries no crypto in the framework: verification is delegated to a pluggable facilitator (Coinbase, Alchemy, self-hosted), so Base and Solana are just different facilitators.
|
||||
Call it via curl
|
||||
|
||||
```bash
|
||||
# Charge for tool calls at the MCP gateway (off unless you set a pay-to address)
|
||||
micro mcp serve --x402-pay-to 0xYourAddress --x402-network solana --x402-amount 10000
|
||||
# Per-tool amounts via a config file
|
||||
micro mcp serve --x402-config x402.json
|
||||
curl -XPOST \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'Micro-Endpoint: Say.Hello' \
|
||||
-d '{"name": "alice"}' \
|
||||
http://localhost:8080
|
||||
```
|
||||
|
||||
See the [Payments (x402) guide](internal/website/docs/guides/x402-payments.md).
|
||||
## Experimental
|
||||
|
||||
### Reachable by other agents (A2A)
|
||||
There's a new `genai` package for generative AI capabilities.
|
||||
|
||||
Within a Go Micro system, agents reach each other over RPC. To make them reachable by agents on *other* frameworks, Go Micro speaks the [Agent2Agent (A2A) protocol](https://a2a-protocol.org). The A2A gateway discovers your agents from the registry, generates an Agent Card for each from its metadata — the same way the MCP gateway derives tools from service endpoints — and translates incoming A2A tasks to the agent's `Agent.Chat` RPC. No per-agent code: register an agent and it's reachable over A2A.
|
||||
## Protobuf
|
||||
|
||||
Install the code generator and see usage in the docs:
|
||||
|
||||
```bash
|
||||
micro a2a serve --address :4000 # gateway: expose every registered agent over A2A
|
||||
micro a2a list # agents and their Agent Card URLs
|
||||
go install go-micro.dev/v5/cmd/protoc-gen-micro@v5.13.0
|
||||
```
|
||||
|
||||
Or skip the gateway entirely — an agent can serve its own A2A endpoint directly, handling tasks in-process:
|
||||
> **Note:** Use a specific version instead of `@latest` to avoid module path conflicts. See [releases](https://github.com/micro/go-micro/releases) for the latest version.
|
||||
|
||||
```go
|
||||
micro.NewAgent("task-mgr", micro.AgentServices("task"), micro.AgentA2A(":4000"))
|
||||
Docs: [`internal/website/docs/getting-started.md`](internal/website/docs/getting-started.md)
|
||||
|
||||
## Command Line
|
||||
|
||||
Install the CLI:
|
||||
|
||||
```
|
||||
go install go-micro.dev/v5/cmd/micro@v5.13.0
|
||||
```
|
||||
|
||||
It works both ways. To call an agent on another framework, an `a2a.Client` is wired into the two places that hand off work: `flow.A2A(url)` as a workflow step (the cross-framework `Dispatch`), and `delegate` to an `http(s)` URL from inside an agent.
|
||||
> **Note:** Use a specific version instead of `@latest` to avoid module path conflicts. See [releases](https://github.com/micro/go-micro/releases) for the latest version.
|
||||
|
||||
MCP exposes your services as tools; A2A exposes your agents as agents. See the [A2A guide](internal/website/docs/guides/a2a-protocol.md).
|
||||
### Quick Start
|
||||
|
||||
## Features
|
||||
|
||||
### AI
|
||||
|
||||
| Feature | Details |
|
||||
|---------|---------|
|
||||
| Agents | `micro.NewAgent()` — intelligent layer that manages services |
|
||||
| Plan & delegate | Built-in agent tools — plan multi-step work, delegate subtasks to other agents |
|
||||
| Pluggable memory | Durable store-backed conversation memory by default; swap with `AgentMemory` |
|
||||
| Custom tools | `AgentTool` — give an agent any function as a tool, beyond its services |
|
||||
| Guardrails | `MaxSteps` (stop on count), `LoopLimit` (stop repeated no-progress calls), `ApproveTool` (human-in-the-loop) |
|
||||
| Tool middleware | `AgentWrapTool` — wrap tool execution for logging, metrics, or retries (like client/server wrappers) |
|
||||
| Workflows | `micro.NewFlow()` — event-driven; one step, ordered durable steps, or triggers an agent |
|
||||
| Durable execution | Checkpointed flow steps survive a crash and resume where they stopped; store-backed by default, pluggable backend |
|
||||
| MCP gateway | Every endpoint is an AI tool automatically |
|
||||
| A2A gateway | Every agent is reachable over the Agent2Agent protocol; cards generated from the registry (`micro a2a`) |
|
||||
| Payments (x402) | Opt-in per-call payments for tools via the x402 standard; pluggable facilitator (Base, Solana, …) |
|
||||
| 7 LLM providers | Anthropic, OpenAI, Gemini, Groq, Mistral, Together, Atlas Cloud |
|
||||
| Interactive console | `micro run` includes a chat console for talking to services |
|
||||
| Service generation | `micro run --prompt` — describe a system, get running services |
|
||||
|
||||
### Framework
|
||||
|
||||
| Feature | Details |
|
||||
|---------|---------|
|
||||
| Service registry | mDNS (default), Consul, etcd |
|
||||
| RPC client/server | gRPC transport, load balancing, streaming |
|
||||
| Pub/sub events | NATS, RabbitMQ, HTTP broker |
|
||||
| Key-value store | File (bbolt), Postgres, NATS KV |
|
||||
| Typed model layer | CRUD + queries, SQLite/Postgres backends |
|
||||
| Everything swappable | All abstractions are Go interfaces |
|
||||
|
||||
### Developer experience & deployment
|
||||
|
||||
| Feature | Details |
|
||||
|---------|---------|
|
||||
| Hot reload | `micro run` watches files, rebuilds on change |
|
||||
| Templates | `micro new --template crud/pubsub/api` |
|
||||
| One-command deploy | `micro deploy user@server` — SSH + systemd, no Docker |
|
||||
|
||||
## CLI
|
||||
|
||||
| Command | Purpose |
|
||||
|---------|---------|
|
||||
| `micro run --prompt "..."` | Generate services + agent, start with interactive console |
|
||||
| `micro run` | Dev mode: hot reload, gateway, interactive console |
|
||||
| `micro run -d` | Detached mode (no console) |
|
||||
| `micro chat` | Standalone chat (when not using micro run) |
|
||||
| `micro agent list` | List registered agents |
|
||||
| `micro new myservice` | Scaffold a service |
|
||||
| `micro call service endpoint '{}'` | Call a service or agent from the CLI |
|
||||
| `micro build` | Compile production binaries |
|
||||
| `micro deploy user@server` | Deploy via SSH + systemd |
|
||||
|
||||
## Multi-Service Projects
|
||||
|
||||
Run multiple services together:
|
||||
|
||||
```go
|
||||
users := micro.NewService("users", micro.Address(":9001"))
|
||||
orders := micro.NewService("orders", micro.Address(":9002"))
|
||||
|
||||
users.Handle(new(Users))
|
||||
orders.Handle(new(Orders))
|
||||
|
||||
g := micro.NewGroup(users, orders)
|
||||
g.Run()
|
||||
```bash
|
||||
micro new helloworld # Create a new service
|
||||
cd helloworld
|
||||
micro run # Run with API gateway
|
||||
```
|
||||
|
||||
Or use a `micro.mu` config file:
|
||||
Then open http://localhost:8080 to see your service and call it from the browser.
|
||||
|
||||
### micro run
|
||||
|
||||
`micro run` starts your services with:
|
||||
- **API Gateway** - HTTP to RPC proxy at `/api/{service}/{method}`
|
||||
- **Web Dashboard** - Browse and call services at `/`
|
||||
- **Health Checks** - Aggregated health at `/health`
|
||||
- **Hot Reload** - Auto-rebuild on file changes
|
||||
|
||||
```bash
|
||||
micro run # Gateway on :8080
|
||||
micro run --address :3000 # Custom gateway port
|
||||
micro run --no-gateway # Services only
|
||||
micro run --env production # Use production environment
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
For multi-service projects, create a `micro.mu` file:
|
||||
|
||||
```
|
||||
service users
|
||||
path ./users
|
||||
port 8081
|
||||
|
||||
service orders
|
||||
path ./orders
|
||||
service posts
|
||||
path ./posts
|
||||
port 8082
|
||||
depends users
|
||||
|
||||
env development
|
||||
DATABASE_URL sqlite://./dev.db
|
||||
```
|
||||
|
||||
## Data Model
|
||||
The gateway runs on :8080 by default, so services should use other ports.
|
||||
|
||||
Typed persistence with CRUD and queries:
|
||||
### Deployment
|
||||
|
||||
```go
|
||||
type User struct {
|
||||
ID string `json:"id" model:"key"`
|
||||
Name string `json:"name"`
|
||||
Email string `json:"email" model:"index"`
|
||||
}
|
||||
Deploy to any Linux server with systemd:
|
||||
|
||||
db := service.Model()
|
||||
db.Register(&User{})
|
||||
db.Create(ctx, &User{ID: "1", Name: "Alice", Email: "alice@example.com"})
|
||||
```bash
|
||||
# On your server (one-time setup)
|
||||
curl -fsSL https://go-micro.dev/install.sh | sh
|
||||
sudo micro init --server
|
||||
|
||||
var results []*User
|
||||
db.List(ctx, &results, model.Where("email", "alice@example.com"))
|
||||
# From your laptop
|
||||
micro deploy user@your-server
|
||||
```
|
||||
|
||||
Backends: memory (default), SQLite, Postgres.
|
||||
The deploy command:
|
||||
1. Builds binaries for Linux
|
||||
2. Copies via SSH to the server
|
||||
3. Sets up systemd services
|
||||
4. Verifies services are healthy
|
||||
|
||||
## AI Providers
|
||||
|
||||
Swap providers with a single import — same interface everywhere:
|
||||
|
||||
| Provider | Default Model |
|
||||
|----------|---------------|
|
||||
| Anthropic | `claude-sonnet-4-20250514` |
|
||||
| OpenAI | `gpt-4o` |
|
||||
| Google Gemini | `gemini-2.5-flash` |
|
||||
| Groq | `llama-3.3-70b-versatile` |
|
||||
| Mistral | `mistral-large-latest` |
|
||||
| Together AI | `Llama-3.3-70B-Instruct-Turbo` |
|
||||
| Atlas Cloud | `llama-3.3-70b` |
|
||||
|
||||
```go
|
||||
m := ai.New("anthropic", ai.WithAPIKey(key))
|
||||
resp, _ := m.Generate(ctx, &ai.Request{Prompt: "hello"})
|
||||
Manage deployed services:
|
||||
```bash
|
||||
micro status --remote user@server # Check status
|
||||
micro logs --remote user@server # View logs
|
||||
micro logs myservice --remote user@server -f # Follow specific service
|
||||
```
|
||||
|
||||
## Examples
|
||||
No Docker required. No Kubernetes. Just systemd.
|
||||
|
||||
- [hello-world](examples/hello-world/) — Basic RPC service
|
||||
- [multi-service](examples/multi-service/) — Multiple services in one binary
|
||||
- [mcp](examples/mcp/) — MCP integration with AI agents
|
||||
- [agent-plan-delegate](examples/agent-plan-delegate/) — Agent planning and multi-agent delegation
|
||||
- [grpc-interop](examples/grpc-interop/) — Call go-micro from any gRPC client
|
||||
See [docs/deployment.md](docs/deployment.md) for full deployment guide.
|
||||
|
||||
See [all examples](examples/README.md).
|
||||
See [cmd/micro/README.md](cmd/micro/README.md) for full CLI documentation.
|
||||
|
||||
## Docs
|
||||
Docs: [`internal/website/docs`](internal/website/docs)
|
||||
|
||||
- [Getting Started](internal/website/docs/getting-started.md)
|
||||
- [AI Integration](internal/website/docs/ai-integration.md)
|
||||
- [Agents and Workflows](internal/website/docs/guides/agents-and-workflows.md)
|
||||
- [Agent Design](internal/docs/AGENT_DESIGN.md)
|
||||
- [Plan & Delegate](internal/website/docs/guides/plan-delegate.md)
|
||||
- [Agent Guardrails](internal/website/docs/guides/agent-guardrails.md)
|
||||
- [Payments (x402)](internal/website/docs/guides/x402-payments.md)
|
||||
- [MCP & AI Agents](internal/website/docs/mcp.md)
|
||||
- [Data Model](internal/website/docs/model.md)
|
||||
- [Deployment](internal/website/docs/deployment.md)
|
||||
- [Plugins](internal/website/docs/plugins.md)
|
||||
Package reference: https://pkg.go.dev/go-micro.dev/v5
|
||||
|
||||
Package reference: https://pkg.go.dev/go-micro.dev/v6
|
||||
Selected topics:
|
||||
- Getting Started: [`internal/website/docs/getting-started.md`](internal/website/docs/getting-started.md)
|
||||
- Plugins overview: [`internal/website/docs/plugins.md`](internal/website/docs/plugins.md)
|
||||
- Learn by Example: [`internal/website/docs/examples/index.md`](internal/website/docs/examples/index.md)
|
||||
- Performance Considerations: [`docs/performance.md`](docs/performance.md)
|
||||
|
||||
## Adopters
|
||||
|
||||
- [Sourse](https://sourse.eu) - Work in the field of earth observation, including embedded Kubernetes running onboard aircraft, and we’ve built a mission management SaaS platform using Go Micro.
|
||||
|
||||
+13
-32
@@ -2,27 +2,16 @@
|
||||
|
||||
This roadmap outlines the planned features and improvements for Go Micro. Community feedback and contributions are welcome!
|
||||
|
||||
> **See [internal/docs/ROADMAP_2026.md](internal/docs/ROADMAP_2026.md) for the AI-Native Era roadmap** focused on MCP integration, agent-first development, and business sustainability. This document covers general framework improvements.
|
||||
|
||||
## Current Focus (Q1 2026) - COMPLETE
|
||||
## Current Focus (Q1 2026)
|
||||
|
||||
### Documentation & Developer Experience
|
||||
- [x] Modernize documentation structure
|
||||
- [x] Add learn-by-example guides
|
||||
- [x] Update issue templates
|
||||
- [x] MCP integration documentation
|
||||
- [x] Agent playground and MCP tools registry
|
||||
- [ ] Create video tutorials
|
||||
- [ ] Interactive documentation site
|
||||
- [ ] Plugin discovery dashboard
|
||||
|
||||
### AI & Model Integration
|
||||
- [x] AI package with provider abstraction (`ai.Model` interface)
|
||||
- [x] Anthropic Claude provider (`ai/anthropic`)
|
||||
- [x] OpenAI GPT provider (`ai/openai`)
|
||||
- [x] Tool execution with auto-calling support
|
||||
- [x] Streaming support via `ai.Stream`
|
||||
|
||||
### Observability
|
||||
- [ ] OpenTelemetry native support
|
||||
- [ ] Auto-instrumentation for handlers
|
||||
@@ -31,10 +20,7 @@ This roadmap outlines the planned features and improvements for Go Micro. Commun
|
||||
- [ ] Integration with popular observability platforms
|
||||
|
||||
### Developer Tools
|
||||
- [x] `micro run` with hot reload and unified gateway
|
||||
- [x] `micro deploy` with SSH + systemd deployment
|
||||
- [x] `micro mcp` command suite (serve, list, test, docs, export)
|
||||
- [ ] `micro dev` with enhanced hot reload
|
||||
- [ ] `micro dev` with hot reload
|
||||
- [ ] Service templates (`micro new --template`)
|
||||
- [ ] Better error messages with suggestions
|
||||
- [ ] Debug tooling improvements
|
||||
@@ -43,8 +29,8 @@ This roadmap outlines the planned features and improvements for Go Micro. Commun
|
||||
## Q2 2026
|
||||
|
||||
### Production Readiness
|
||||
- [x] Health check standardization
|
||||
- [x] Graceful shutdown improvements
|
||||
- [ ] Health check standardization
|
||||
- [ ] Graceful shutdown improvements
|
||||
- [ ] Resource cleanup best practices
|
||||
- [ ] Load testing framework integration
|
||||
- [ ] Performance benchmarking suite
|
||||
@@ -57,10 +43,6 @@ This roadmap outlines the planned features and improvements for Go Micro. Commun
|
||||
- [ ] Multi-cluster patterns
|
||||
|
||||
### Security
|
||||
- [x] Bearer token authentication for MCP
|
||||
- [x] Per-tool scope enforcement
|
||||
- [x] Audit logging
|
||||
- [x] Rate limiting
|
||||
- [ ] mTLS by default option
|
||||
- [ ] Secret management integration (Vault, AWS Secrets Manager)
|
||||
- [ ] RBAC improvements
|
||||
@@ -78,7 +60,7 @@ This roadmap outlines the planned features and improvements for Go Micro. Commun
|
||||
|
||||
### Streaming & Async
|
||||
- [ ] Improved streaming support
|
||||
- [x] Server-sent events (SSE) support (via MCP gateway)
|
||||
- [ ] Server-sent events (SSE) support
|
||||
- [ ] WebSocket plugin
|
||||
- [ ] Event sourcing patterns
|
||||
- [ ] CQRS examples
|
||||
@@ -132,7 +114,6 @@ This roadmap outlines the planned features and improvements for Go Micro. Commun
|
||||
### Differentiation
|
||||
- **Batteries included, fully swappable** - Start simple, scale complex
|
||||
- **Zero-config local development** - No infrastructure required to start
|
||||
- **AI-native by default** - Every service is an MCP tool automatically
|
||||
- **Plugin ecosystem in-repo** - No version compatibility hell
|
||||
- **Progressive complexity** - Learn as you grow
|
||||
- **Cloud-native first** - Built for Kubernetes and containers
|
||||
@@ -142,11 +123,11 @@ This roadmap outlines the planned features and improvements for Go Micro. Commun
|
||||
We welcome contributions to any roadmap items! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
||||
|
||||
### High Priority Areas
|
||||
1. Documentation improvements (guides, tutorials)
|
||||
2. Multi-protocol MCP support (WebSocket, gRPC)
|
||||
3. Agent SDK integrations (LlamaIndex, AutoGPT)
|
||||
4. OpenTelemetry integration
|
||||
5. Kubernetes operator and Helm charts
|
||||
1. Documentation improvements
|
||||
2. Real-world examples
|
||||
3. Plugin development
|
||||
4. Performance optimizations
|
||||
5. Testing infrastructure
|
||||
|
||||
### How to Contribute
|
||||
- Pick an item from the roadmap
|
||||
@@ -156,7 +137,7 @@ We welcome contributions to any roadmap items! See [CONTRIBUTING.md](CONTRIBUTIN
|
||||
|
||||
## Feedback
|
||||
|
||||
Have suggestions for the roadmap?
|
||||
Have suggestions for the roadmap?
|
||||
|
||||
- Open a [feature request](.github/ISSUE_TEMPLATE/feature_request.md)
|
||||
- Start a discussion in GitHub Discussions
|
||||
@@ -177,6 +158,6 @@ We follow semantic versioning:
|
||||
|
||||
---
|
||||
|
||||
Last updated: March 2026
|
||||
Last updated: November 2025
|
||||
|
||||
This roadmap is subject to change based on community needs and priorities.
|
||||
This roadmap is subject to change based on community needs and priorities. Star the repo to stay updated! ⭐
|
||||
|
||||
-179
@@ -1,179 +0,0 @@
|
||||
# Security Policy
|
||||
|
||||
## Supported Versions
|
||||
|
||||
We actively support the following versions of go-micro:
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 5.x | :white_check_mark: |
|
||||
| 4.x | :x: |
|
||||
| 3.x | :x: |
|
||||
| < 3.0 | :x: |
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
**Please do not report security vulnerabilities through public GitHub issues.**
|
||||
|
||||
### How to Report
|
||||
|
||||
Send security vulnerability reports to: **security@go-micro.dev**
|
||||
|
||||
Or use GitHub's private security advisory feature:
|
||||
https://github.com/micro/go-micro/security/advisories/new
|
||||
|
||||
### What to Include
|
||||
|
||||
Please include as much of the following information as possible:
|
||||
|
||||
- Type of vulnerability (e.g., RCE, XSS, SQL injection, etc.)
|
||||
- Full paths of source file(s) related to the vulnerability
|
||||
- Location of the affected source code (tag/branch/commit or direct URL)
|
||||
- Step-by-step instructions to reproduce the issue
|
||||
- Proof-of-concept or exploit code (if possible)
|
||||
- Impact of the issue, including how an attacker might exploit it
|
||||
|
||||
### Response Timeline
|
||||
|
||||
- **Acknowledgment**: Within 48 hours
|
||||
- **Initial Assessment**: Within 5 business days
|
||||
- **Fix Timeline**: Depends on severity
|
||||
- Critical: 7 days
|
||||
- High: 14 days
|
||||
- Medium: 30 days
|
||||
- Low: Next release cycle
|
||||
|
||||
### Disclosure Policy
|
||||
|
||||
- We follow **coordinated disclosure**
|
||||
- We'll work with you to understand and fix the issue
|
||||
- We'll credit you in the security advisory (unless you prefer to remain anonymous)
|
||||
- Please give us reasonable time to fix before public disclosure
|
||||
- We'll publish a security advisory on GitHub when the fix is released
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
When using go-micro in production:
|
||||
|
||||
### TLS/Transport Security
|
||||
|
||||
```go
|
||||
import "go-micro.dev/v5/transport"
|
||||
|
||||
// Enable TLS verification (recommended)
|
||||
os.Setenv("MICRO_TLS_SECURE", "true")
|
||||
|
||||
// Or use SecureConfig explicitly
|
||||
tlsConfig := transport.SecureConfig()
|
||||
```
|
||||
|
||||
See [TLS Security Update](internal/website/docs/TLS_SECURITY_UPDATE.md) for details.
|
||||
|
||||
### Authentication
|
||||
|
||||
```go
|
||||
import "go-micro.dev/v5/auth"
|
||||
|
||||
// Use JWT authentication
|
||||
service := micro.NewService(
|
||||
micro.Auth(auth.NewAuth()),
|
||||
)
|
||||
```
|
||||
|
||||
### Input Validation
|
||||
|
||||
Always validate and sanitize inputs in your handlers:
|
||||
|
||||
```go
|
||||
func (h *Handler) Create(ctx context.Context, req *Request, rsp *Response) error {
|
||||
// Validate input
|
||||
if req.Name == "" {
|
||||
return errors.BadRequest("handler.create", "name is required")
|
||||
}
|
||||
|
||||
// Sanitize and process
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
### Rate Limiting
|
||||
|
||||
Implement rate limiting for public-facing services:
|
||||
|
||||
```go
|
||||
import "go-micro.dev/v5/client"
|
||||
|
||||
// Client-side rate limiting
|
||||
client.NewClient(
|
||||
client.RequestTimeout(time.Second * 5),
|
||||
client.Retries(3),
|
||||
)
|
||||
```
|
||||
|
||||
### Secrets Management
|
||||
|
||||
Never commit secrets to version control:
|
||||
|
||||
```go
|
||||
// Good: Use environment variables
|
||||
apiKey := os.Getenv("API_KEY")
|
||||
|
||||
// Better: Use a secrets manager
|
||||
import "github.com/hashicorp/vault/api"
|
||||
```
|
||||
|
||||
### Dependency Security
|
||||
|
||||
Regularly update dependencies:
|
||||
|
||||
```bash
|
||||
# Check for vulnerabilities
|
||||
go list -json -m all | nancy sleuth
|
||||
|
||||
# Update dependencies
|
||||
go get -u ./...
|
||||
go mod tidy
|
||||
```
|
||||
|
||||
## Known Security Considerations
|
||||
|
||||
### Reflection Usage
|
||||
|
||||
go-micro uses reflection for automatic handler registration. While this is a deliberate design choice for developer productivity, be aware:
|
||||
|
||||
- Type safety is enforced at runtime, not compile time
|
||||
- Malformed requests won't crash services (errors are returned)
|
||||
- See [Performance Considerations](internal/website/docs/performance.md)
|
||||
|
||||
### TLS Certificate Verification
|
||||
|
||||
**Default behavior in v5**: TLS certificate verification is **disabled** for backward compatibility.
|
||||
|
||||
**Production recommendation**: Enable secure mode:
|
||||
|
||||
```bash
|
||||
export MICRO_TLS_SECURE=true
|
||||
```
|
||||
|
||||
This will be the default in v6.
|
||||
|
||||
## Security Updates
|
||||
|
||||
Security updates are published as:
|
||||
- GitHub Security Advisories
|
||||
- Release notes with `[SECURITY]` prefix
|
||||
- CVE entries for critical issues
|
||||
|
||||
Subscribe to releases: https://github.com/micro/go-micro/releases
|
||||
|
||||
## Bug Bounty
|
||||
|
||||
We currently do not offer a bug bounty program, but we greatly appreciate responsible disclosure and will publicly credit researchers who report valid security issues.
|
||||
|
||||
## Questions?
|
||||
|
||||
For security questions that are not vulnerabilities, please:
|
||||
- Open a discussion: https://github.com/micro/go-micro/discussions
|
||||
- Join Discord: https://discord.gg/WeMU5AGxD
|
||||
- Email: support@go-micro.dev
|
||||
|
||||
-348
@@ -1,348 +0,0 @@
|
||||
// Package agent provides the Agent abstraction for Go Micro.
|
||||
//
|
||||
// An Agent is a service with an LLM inside it. It registers a Chat
|
||||
// RPC endpoint, discovers its assigned services' tools, and
|
||||
// orchestrates them intelligently.
|
||||
//
|
||||
// agent := micro.NewAgent("task-mgr",
|
||||
// micro.AgentServices("task"),
|
||||
// micro.AgentPrompt("You manage tasks."),
|
||||
// micro.AgentProvider("anthropic"),
|
||||
// )
|
||||
// agent.Run()
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"github.com/google/uuid"
|
||||
pb "go-micro.dev/v6/agent/proto"
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/gateway/a2a"
|
||||
"go-micro.dev/v6/server"
|
||||
"go-micro.dev/v6/store"
|
||||
|
||||
_ "go-micro.dev/v6/ai/anthropic"
|
||||
_ "go-micro.dev/v6/ai/atlascloud"
|
||||
_ "go-micro.dev/v6/ai/gemini"
|
||||
_ "go-micro.dev/v6/ai/groq"
|
||||
_ "go-micro.dev/v6/ai/mistral"
|
||||
_ "go-micro.dev/v6/ai/openai"
|
||||
_ "go-micro.dev/v6/ai/together"
|
||||
)
|
||||
|
||||
// Agent is the interface for an AI agent that manages services.
|
||||
type Agent interface {
|
||||
Name() string
|
||||
Init(...Option)
|
||||
Options() Options
|
||||
Ask(ctx context.Context, message string) (*Response, error)
|
||||
Run() error
|
||||
Stop() error
|
||||
String() string
|
||||
}
|
||||
|
||||
// Response is what an agent returns from Chat.
|
||||
type Response struct {
|
||||
Reply string
|
||||
ToolCalls []ai.ToolCall
|
||||
Agent string
|
||||
}
|
||||
|
||||
type agentImpl struct {
|
||||
opts Options
|
||||
model ai.Model
|
||||
tools *ai.Tools
|
||||
mem Memory
|
||||
server server.Server
|
||||
mu sync.Mutex
|
||||
|
||||
// ephemeral marks a short-lived sub-agent created by delegation.
|
||||
// Ephemeral agents run with an isolated context: they load and
|
||||
// persist no history, and have no built-in tools (so they cannot
|
||||
// plan or re-delegate).
|
||||
ephemeral bool
|
||||
|
||||
// steps counts tool executions in the current Ask, for MaxSteps.
|
||||
steps int
|
||||
// calls counts identical tool calls (name+args) in the current Ask,
|
||||
// for LoopLimit.
|
||||
calls map[string]int
|
||||
|
||||
// runID correlates the tool calls of the current Ask; parentRunID is
|
||||
// the run that delegated to this one (set on ephemeral sub-agents).
|
||||
// Both are surfaced to tool wrappers via ai.RunInfo on the context.
|
||||
runID string
|
||||
parentRunID string
|
||||
}
|
||||
|
||||
// New creates a new Agent.
|
||||
func New(opts ...Option) Agent {
|
||||
return &agentImpl{
|
||||
opts: newOptions(opts...),
|
||||
}
|
||||
}
|
||||
|
||||
// newEphemeral creates a short-lived sub-agent for a delegated subtask.
|
||||
// It shares the parent's provider, model, and infrastructure but runs
|
||||
// with an isolated context: it loads and persists no history and has no
|
||||
// built-in tools (so it can neither plan nor re-delegate). Returns the
|
||||
// concrete type because ephemeral is an internal construction detail,
|
||||
// not a public option.
|
||||
func newEphemeral(opts ...Option) *agentImpl {
|
||||
return &agentImpl{
|
||||
opts: newOptions(opts...),
|
||||
ephemeral: true,
|
||||
}
|
||||
}
|
||||
|
||||
func (a *agentImpl) Name() string {
|
||||
return a.opts.Name
|
||||
}
|
||||
|
||||
func (a *agentImpl) Init(opts ...Option) {
|
||||
for _, o := range opts {
|
||||
o(&a.opts)
|
||||
}
|
||||
a.setup()
|
||||
}
|
||||
|
||||
func (a *agentImpl) Options() Options {
|
||||
return a.opts
|
||||
}
|
||||
|
||||
func (a *agentImpl) String() string {
|
||||
return "agent"
|
||||
}
|
||||
|
||||
func (a *agentImpl) setup() {
|
||||
var modelOpts []ai.Option
|
||||
modelOpts = append(modelOpts, ai.WithAPIKey(a.opts.APIKey))
|
||||
if a.opts.Model != "" {
|
||||
modelOpts = append(modelOpts, ai.WithModel(a.opts.Model))
|
||||
}
|
||||
|
||||
a.tools = ai.NewTools(a.opts.Registry, ai.ToolClient(a.opts.Client))
|
||||
modelOpts = append(modelOpts, ai.WithToolHandler(a.toolHandler()))
|
||||
a.model = ai.New(a.opts.Provider, modelOpts...)
|
||||
|
||||
// Memory is pluggable. Use the configured one, otherwise the default
|
||||
// store-backed memory — except ephemeral sub-agents, which keep an
|
||||
// isolated, non-persistent context.
|
||||
switch {
|
||||
case a.opts.Memory != nil:
|
||||
a.mem = a.opts.Memory
|
||||
case a.ephemeral:
|
||||
a.mem = NewInMemory(a.opts.HistoryLimit)
|
||||
default:
|
||||
a.mem = NewMemory(a.stateStore(), "history", a.opts.HistoryLimit)
|
||||
}
|
||||
}
|
||||
|
||||
// stateStore returns the agent's own state store, scoped to its name so
|
||||
// memory and plan live in their own table ("agent/{name}") rather than a
|
||||
// shared global one. The scoped handle injects the database/table per
|
||||
// operation without mutating the underlying store.
|
||||
func (a *agentImpl) stateStore() store.Store {
|
||||
s := a.opts.Store
|
||||
if s == nil {
|
||||
s = store.DefaultStore
|
||||
}
|
||||
return store.Scope(s, "agent", a.opts.Name)
|
||||
}
|
||||
|
||||
// Ask sends a message and returns the agent's response.
|
||||
// This is the programmatic API for direct use.
|
||||
func (a *agentImpl) Ask(ctx context.Context, message string) (*Response, error) {
|
||||
a.mu.Lock()
|
||||
defer a.mu.Unlock()
|
||||
|
||||
if a.model == nil {
|
||||
a.setup()
|
||||
}
|
||||
|
||||
toolList, err := a.discoverTools()
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("discover tools: %w", err)
|
||||
}
|
||||
|
||||
a.mem.Add("user", message)
|
||||
a.steps = 0
|
||||
a.calls = map[string]int{}
|
||||
|
||||
// Correlate this run's tool calls and surface lineage to wrappers.
|
||||
a.runID = uuid.New().String()
|
||||
ctx = ai.WithRunInfo(ctx, ai.RunInfo{
|
||||
RunID: a.runID,
|
||||
ParentID: a.parentRunID,
|
||||
Agent: a.opts.Name,
|
||||
})
|
||||
|
||||
resp, err := a.model.Generate(ctx, &ai.Request{
|
||||
Prompt: message,
|
||||
SystemPrompt: a.buildPrompt(),
|
||||
Tools: toolList,
|
||||
Messages: a.mem.Messages(),
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if resp.Reply != "" {
|
||||
a.mem.Add("assistant", resp.Reply)
|
||||
}
|
||||
if resp.Answer != "" {
|
||||
a.mem.Add("assistant", resp.Answer)
|
||||
}
|
||||
|
||||
reply := resp.Reply
|
||||
if resp.Answer != "" {
|
||||
if reply != "" {
|
||||
reply += "\n\n"
|
||||
}
|
||||
reply += resp.Answer
|
||||
}
|
||||
|
||||
return &Response{
|
||||
Reply: reply,
|
||||
ToolCalls: resp.ToolCalls,
|
||||
Agent: a.opts.Name,
|
||||
}, nil
|
||||
}
|
||||
|
||||
// Chat implements the proto AgentHandler interface for RPC.
|
||||
// @example {"message": "What tasks are overdue?"}
|
||||
func (a *agentImpl) Chat(ctx context.Context, req *pb.ChatRequest, rsp *pb.ChatResponse) error {
|
||||
resp, err := a.Ask(ctx, req.Message)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
rsp.Reply = resp.Reply
|
||||
rsp.Agent = resp.Agent
|
||||
for _, tc := range resp.ToolCalls {
|
||||
input, _ := json.Marshal(tc.Input)
|
||||
rsp.ToolCalls = append(rsp.ToolCalls, &pb.ToolCall{
|
||||
Id: tc.ID,
|
||||
Name: tc.Name,
|
||||
Input: string(input),
|
||||
Result: tc.Result,
|
||||
})
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Run starts the agent as a service with a Chat RPC endpoint.
|
||||
func (a *agentImpl) Run() error {
|
||||
if a.model == nil {
|
||||
a.setup()
|
||||
}
|
||||
|
||||
a.server = server.NewServer(
|
||||
server.Name(a.opts.Name),
|
||||
server.Registry(a.opts.Registry),
|
||||
server.Metadata(map[string]string{
|
||||
"type": "agent",
|
||||
"services": strings.Join(a.opts.Services, ","),
|
||||
}),
|
||||
)
|
||||
|
||||
pb.RegisterAgentHandler(a.server, a)
|
||||
|
||||
if err := a.server.Start(); err != nil {
|
||||
return fmt.Errorf("failed to start agent: %w", err)
|
||||
}
|
||||
|
||||
fmt.Printf("Agent %s registered (manages: %s)\n", a.opts.Name, strings.Join(a.opts.Services, ", "))
|
||||
|
||||
// Optionally serve the agent directly over the A2A protocol, calling
|
||||
// Ask in-process — no separate gateway needed to be queried by URL.
|
||||
if a.opts.A2AAddress != "" {
|
||||
card := a2a.Card(a.opts.Name, "http://localhost"+a.opts.A2AAddress, "", a.opts.Services)
|
||||
handler := a2a.NewAgentHandler(card, func(ctx context.Context, text string) (string, error) {
|
||||
resp, err := a.Ask(ctx, text)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return resp.Reply, nil
|
||||
})
|
||||
go func() {
|
||||
if err := http.ListenAndServe(a.opts.A2AAddress, handler); err != nil {
|
||||
fmt.Printf("agent %s A2A server: %v\n", a.opts.Name, err)
|
||||
}
|
||||
}()
|
||||
fmt.Printf("Agent %s serving A2A on %s\n", a.opts.Name, a.opts.A2AAddress)
|
||||
}
|
||||
|
||||
ch := make(chan struct{})
|
||||
<-ch
|
||||
return nil
|
||||
}
|
||||
|
||||
func (a *agentImpl) Stop() error {
|
||||
if a.server != nil {
|
||||
return a.server.Stop()
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (a *agentImpl) discoverTools() ([]ai.Tool, error) {
|
||||
all, err := a.tools.Discover()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var scoped []ai.Tool
|
||||
for _, t := range all {
|
||||
if strings.HasPrefix(t.OriginalName, a.opts.Name+".") {
|
||||
continue
|
||||
}
|
||||
if len(a.opts.Services) == 0 {
|
||||
scoped = append(scoped, t)
|
||||
continue
|
||||
}
|
||||
for _, svc := range a.opts.Services {
|
||||
if strings.HasPrefix(t.OriginalName, svc+".") {
|
||||
scoped = append(scoped, t)
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Developer-registered custom tools (WithTool).
|
||||
for i := range a.opts.tools {
|
||||
scoped = append(scoped, a.opts.tools[i].def)
|
||||
}
|
||||
|
||||
// Expose the agent's own capabilities (plan, delegate) as tools.
|
||||
// Ephemeral sub-agents don't get them.
|
||||
if !a.ephemeral {
|
||||
scoped = append(scoped, builtinTools()...)
|
||||
}
|
||||
return scoped, nil
|
||||
}
|
||||
|
||||
func (a *agentImpl) buildPrompt() string {
|
||||
var base string
|
||||
switch {
|
||||
case a.opts.Prompt != "":
|
||||
base = a.opts.Prompt
|
||||
case len(a.opts.Services) > 0:
|
||||
base = fmt.Sprintf("You are the %s agent. You manage these services: %s. Use the available tools to fulfill requests.",
|
||||
a.opts.Name, strings.Join(a.opts.Services, ", "))
|
||||
default:
|
||||
base = fmt.Sprintf("You are the %s agent. Use the available tools to fulfill requests.", a.opts.Name)
|
||||
}
|
||||
|
||||
// Keep the agent oriented: surface its saved plan, if any.
|
||||
if !a.ephemeral {
|
||||
if plan := a.loadPlan(); plan != "" {
|
||||
base += "\n\nYour current plan (update it with the plan tool as you make progress):\n" + plan
|
||||
}
|
||||
}
|
||||
return base
|
||||
}
|
||||
@@ -1,88 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestNew(t *testing.T) {
|
||||
a := New(
|
||||
Name("test-agent"),
|
||||
Services("task", "project"),
|
||||
Prompt("You manage tasks."),
|
||||
Provider("anthropic"),
|
||||
)
|
||||
|
||||
if a.Name() != "test-agent" {
|
||||
t.Errorf("Name() = %q, want %q", a.Name(), "test-agent")
|
||||
}
|
||||
|
||||
opts := a.Options()
|
||||
if opts.Provider != "anthropic" {
|
||||
t.Errorf("Provider = %q, want %q", opts.Provider, "anthropic")
|
||||
}
|
||||
if len(opts.Services) != 2 {
|
||||
t.Fatalf("Services = %v, want 2 items", opts.Services)
|
||||
}
|
||||
if opts.Services[0] != "task" || opts.Services[1] != "project" {
|
||||
t.Errorf("Services = %v, want [task project]", opts.Services)
|
||||
}
|
||||
if opts.Prompt != "You manage tasks." {
|
||||
t.Errorf("Prompt = %q, want %q", opts.Prompt, "You manage tasks.")
|
||||
}
|
||||
if opts.HistoryLimit != 50 {
|
||||
t.Errorf("HistoryLimit = %d, want 50", opts.HistoryLimit)
|
||||
}
|
||||
}
|
||||
|
||||
func TestBuildPrompt(t *testing.T) {
|
||||
// Custom prompt
|
||||
a := New(Name("test"), Prompt("custom prompt")).(*agentImpl)
|
||||
if got := a.buildPrompt(); got != "custom prompt" {
|
||||
t.Errorf("buildPrompt() = %q, want %q", got, "custom prompt")
|
||||
}
|
||||
|
||||
// Auto-generated prompt with services
|
||||
a = New(Name("test"), Services("task", "project")).(*agentImpl)
|
||||
got := a.buildPrompt()
|
||||
if got == "" {
|
||||
t.Error("buildPrompt() returned empty")
|
||||
}
|
||||
if !contains(got, "task") || !contains(got, "project") {
|
||||
t.Errorf("buildPrompt() = %q, should mention services", got)
|
||||
}
|
||||
|
||||
// Auto-generated prompt without services
|
||||
a = New(Name("test")).(*agentImpl)
|
||||
got = a.buildPrompt()
|
||||
if !contains(got, "test") {
|
||||
t.Errorf("buildPrompt() = %q, should mention agent name", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDefaults(t *testing.T) {
|
||||
a := New(Name("test"))
|
||||
opts := a.Options()
|
||||
|
||||
if opts.Registry == nil {
|
||||
t.Error("Registry should default to DefaultRegistry")
|
||||
}
|
||||
if opts.Client == nil {
|
||||
t.Error("Client should default to DefaultClient")
|
||||
}
|
||||
if opts.Store == nil {
|
||||
t.Error("Store should default to DefaultStore")
|
||||
}
|
||||
}
|
||||
|
||||
func contains(s, sub string) bool {
|
||||
return len(s) >= len(sub) && (s == sub || len(s) > 0 && containsStr(s, sub))
|
||||
}
|
||||
|
||||
func containsStr(s, sub string) bool {
|
||||
for i := 0; i <= len(s)-len(sub); i++ {
|
||||
if s[i:i+len(sub)] == sub {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
@@ -1,340 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
codecBytes "go-micro.dev/v6/codec/bytes"
|
||||
"go-micro.dev/v6/gateway/a2a"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
// Built-in agent tools. These are not service endpoints — they are
|
||||
// capabilities the agent has over itself: maintaining a plan in its
|
||||
// memory, and delegating a subtask to another agent.
|
||||
//
|
||||
// They are plain tools, wired into the agent's tool handler alongside
|
||||
// the discovered service tools. There is no separate harness or graph:
|
||||
// the LLM calls them like any other tool.
|
||||
const (
|
||||
toolPlan = "plan"
|
||||
toolDelegate = "delegate"
|
||||
)
|
||||
|
||||
// builtinTools returns the tool definitions exposed to the model in
|
||||
// addition to the agent's scoped service tools.
|
||||
func builtinTools() []ai.Tool {
|
||||
return []ai.Tool{
|
||||
{
|
||||
Name: toolPlan,
|
||||
OriginalName: toolPlan,
|
||||
Description: "Record or update your plan as an ordered list of steps before doing multi-step work. " +
|
||||
"Call this whenever the plan changes. The plan is saved to your memory and shown back to you on later turns.",
|
||||
Properties: map[string]any{
|
||||
"steps": map[string]any{
|
||||
"type": "array",
|
||||
"description": "Ordered plan steps. Each step has a 'task' (string) and a " +
|
||||
"'status' (one of: pending, in_progress, done).",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Name: toolDelegate,
|
||||
OriginalName: toolDelegate,
|
||||
Description: "Delegate a self-contained subtask to another agent. If 'to' names an agent that already " +
|
||||
"manages the relevant services, that agent handles it; otherwise a focused sub-agent is created for the " +
|
||||
"subtask. The sub-agent works in an isolated context and returns only its result. Use this to keep your " +
|
||||
"own context focused and to let domain experts handle their own services.",
|
||||
Properties: map[string]any{
|
||||
"task": map[string]any{
|
||||
"type": "string",
|
||||
"description": "The subtask to delegate, described completely and self-contained.",
|
||||
},
|
||||
"to": map[string]any{
|
||||
"type": "string",
|
||||
"description": "Optional. The agent or service name best suited to the subtask, or the URL of an external agent that speaks the A2A protocol.",
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// Builtins returns the built-in agent tools (plan, delegate) together
|
||||
// with a handler for them, so the same capabilities can be wired into a
|
||||
// tool loop that isn't a running Agent — for example the `micro chat`
|
||||
// fallback. The handler's third return value is false when the name is
|
||||
// not a built-in, so callers can fall through to their own tools.
|
||||
//
|
||||
// Configure it with the same options as an Agent (Name, Provider,
|
||||
// WithStore, WithRegistry, WithClient, ...); these back plan's memory
|
||||
// and delegate's RPC/sub-agent behaviour.
|
||||
func Builtins(opts ...Option) (tools []ai.Tool, handle func(name string, input map[string]any) (result any, content string, ok bool)) {
|
||||
a := &agentImpl{opts: newOptions(opts...)}
|
||||
handle = func(name string, input map[string]any) (any, string, bool) {
|
||||
switch name {
|
||||
case toolPlan:
|
||||
r := a.handlePlan(ai.ToolCall{Name: name, Input: input})
|
||||
return r.Value, r.Content, true
|
||||
case toolDelegate:
|
||||
r := a.handleDelegate(ai.ToolCall{Name: name, Input: input})
|
||||
return r.Value, r.Content, true
|
||||
}
|
||||
return nil, "", false
|
||||
}
|
||||
return builtinTools(), handle
|
||||
}
|
||||
|
||||
// toolHandler returns the agent's tool-call handler, composed as a stack
|
||||
// of wrappers around a base handler — the same middleware shape as
|
||||
// client/server wrappers. The base executes the call (custom tools,
|
||||
// delegate, or RPC); the built-in guardrails wrap it; developer wrappers
|
||||
// (WrapTool) wrap those, outermost, so they observe every call and its
|
||||
// result including guardrail refusals. Ephemeral sub-agents get the bare
|
||||
// service handler so they can neither plan nor re-delegate (which
|
||||
// prevents runaway recursion).
|
||||
func (a *agentImpl) toolHandler() ai.ToolHandler {
|
||||
if a.ephemeral {
|
||||
return a.tools.Handler()
|
||||
}
|
||||
|
||||
// Innermost first: base, then guardrails (approve → loop → step →
|
||||
// plan), then developer wrappers outermost. Wrapping reverses order,
|
||||
// so the result runs plan → step → loop → approve → base.
|
||||
h := a.baseHandler()
|
||||
h = a.approveWrap(h)
|
||||
h = a.loopWrap(h)
|
||||
h = a.stepWrap(h)
|
||||
h = a.planWrap(h)
|
||||
for i := len(a.opts.wrappers) - 1; i >= 0; i-- {
|
||||
h = a.opts.wrappers[i](h)
|
||||
}
|
||||
return h
|
||||
}
|
||||
|
||||
// baseHandler executes a tool call: a developer custom tool, the built-in
|
||||
// delegate, or an RPC to the service. It is the innermost handler.
|
||||
func (a *agentImpl) baseHandler() ai.ToolHandler {
|
||||
rpc := a.tools.Handler()
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
for i := range a.opts.tools {
|
||||
if a.opts.tools[i].def.Name == call.Name {
|
||||
out, err := a.opts.tools[i].handler(ctx, call.Input)
|
||||
if err != nil {
|
||||
return errResult(call.ID, err.Error())
|
||||
}
|
||||
return ai.ToolResult{ID: call.ID, Value: out, Content: out}
|
||||
}
|
||||
}
|
||||
if call.Name == toolDelegate {
|
||||
return a.handleDelegate(call)
|
||||
}
|
||||
return rpc(ctx, call)
|
||||
}
|
||||
}
|
||||
|
||||
// planWrap handles the plan tool inline. plan is internal bookkeeping,
|
||||
// not an action — it is never counted, loop-checked, or gated.
|
||||
func (a *agentImpl) planWrap(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
if call.Name == toolPlan {
|
||||
return a.handlePlan(call)
|
||||
}
|
||||
return next(ctx, call)
|
||||
}
|
||||
}
|
||||
|
||||
// stepWrap bounds the number of actions per Ask (MaxSteps).
|
||||
func (a *agentImpl) stepWrap(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
if a.opts.MaxSteps > 0 {
|
||||
a.steps++
|
||||
if a.steps > a.opts.MaxSteps {
|
||||
return refused(call.ID, ai.RefusedMaxSteps, fmt.Sprintf(
|
||||
"step limit reached (%d). Do not call any more tools; stop and summarize what you have so far.",
|
||||
a.opts.MaxSteps))
|
||||
}
|
||||
}
|
||||
return next(ctx, call)
|
||||
}
|
||||
}
|
||||
|
||||
// loopWrap stops the agent repeating an identical action that makes no
|
||||
// progress (which the step count alone won't catch).
|
||||
func (a *agentImpl) loopWrap(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
if a.opts.LoopLimit > 0 {
|
||||
if a.calls == nil {
|
||||
a.calls = map[string]int{}
|
||||
}
|
||||
args, _ := json.Marshal(call.Input)
|
||||
fp := call.Name + ":" + string(args)
|
||||
a.calls[fp]++
|
||||
if a.calls[fp] > a.opts.LoopLimit {
|
||||
return refused(call.ID, ai.RefusedLoop, fmt.Sprintf(
|
||||
"loop detected: you have already called %q with the same arguments %d times and the result will not change. Stop repeating it — try a different approach, or finish with what you have.",
|
||||
call.Name, a.opts.LoopLimit))
|
||||
}
|
||||
}
|
||||
return next(ctx, call)
|
||||
}
|
||||
}
|
||||
|
||||
// approveWrap gates each action before it runs (ApproveTool).
|
||||
func (a *agentImpl) approveWrap(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
if a.opts.Approve != nil {
|
||||
if ok, reason := a.opts.Approve(call.Name, call.Input); !ok {
|
||||
msg := "tool call was not approved"
|
||||
if reason != "" {
|
||||
msg += ": " + reason
|
||||
}
|
||||
return refused(call.ID, ai.RefusedApproval, msg)
|
||||
}
|
||||
}
|
||||
return next(ctx, call)
|
||||
}
|
||||
}
|
||||
|
||||
// handlePlan persists the supplied plan to the agent's memory and
|
||||
// echoes it back so the model can see the stored state.
|
||||
func (a *agentImpl) handlePlan(call ai.ToolCall) ai.ToolResult {
|
||||
data, err := json.Marshal(call.Input)
|
||||
if err != nil {
|
||||
return errResult(call.ID, "invalid plan: "+err.Error())
|
||||
}
|
||||
a.stateStore().Write(&store.Record{Key: planKey, Value: data})
|
||||
return ai.ToolResult{ID: call.ID, Value: call.Input, Content: string(data)}
|
||||
}
|
||||
|
||||
// handleDelegate hands a subtask to another agent. Delegate-first:
|
||||
// if 'to' names a registered agent, it is called via RPC. Otherwise an
|
||||
// ephemeral sub-agent is created with a fresh, isolated context, asked
|
||||
// the subtask, and its reply returned.
|
||||
func (a *agentImpl) handleDelegate(call ai.ToolCall) ai.ToolResult {
|
||||
input := call.Input
|
||||
task, _ := input["task"].(string)
|
||||
if task == "" {
|
||||
return errResult(call.ID, "task is required")
|
||||
}
|
||||
to, _ := input["to"].(string)
|
||||
|
||||
// An external agent on another framework, addressed by A2A URL.
|
||||
if strings.HasPrefix(to, "http://") || strings.HasPrefix(to, "https://") {
|
||||
reply, err := a2a.NewClient(to).Send(context.Background(), task)
|
||||
if err != nil {
|
||||
return errResult(call.ID, "delegate to A2A agent "+to+": "+err.Error())
|
||||
}
|
||||
out := map[string]any{"agent": to, "reply": reply}
|
||||
b, _ := json.Marshal(out)
|
||||
return ai.ToolResult{ID: call.ID, Value: out, Content: string(b)}
|
||||
}
|
||||
|
||||
// Delegate-first: an existing agent that owns the domain handles it.
|
||||
if to != "" && a.isAgent(to) {
|
||||
reply, err := a.callAgentRPC(context.Background(), to, task)
|
||||
if err != nil {
|
||||
return errResult(call.ID, "delegate to agent "+to+": "+err.Error())
|
||||
}
|
||||
out := map[string]any{"agent": to, "reply": reply}
|
||||
b, _ := json.Marshal(out)
|
||||
return ai.ToolResult{ID: call.ID, Value: out, Content: string(b)}
|
||||
}
|
||||
|
||||
// Otherwise create a focused, ephemeral sub-agent. Fresh context:
|
||||
// it loads no history and persists none.
|
||||
var svcs []string
|
||||
if to != "" {
|
||||
svcs = []string{to}
|
||||
}
|
||||
sub := newEphemeral(
|
||||
Name(a.opts.Name+".sub"),
|
||||
Services(svcs...),
|
||||
Prompt("You are a sub-agent handling a single delegated subtask. "+
|
||||
"Complete it using the available tools and report the result concisely."),
|
||||
Provider(a.opts.Provider),
|
||||
Model(a.opts.Model),
|
||||
APIKey(a.opts.APIKey),
|
||||
WithRegistry(a.opts.Registry),
|
||||
WithClient(a.opts.Client),
|
||||
WithStore(a.opts.Store),
|
||||
)
|
||||
// Record lineage so the sub-agent's tool calls carry this run as parent.
|
||||
sub.parentRunID = a.runID
|
||||
|
||||
resp, err := sub.Ask(context.Background(), task)
|
||||
if err != nil {
|
||||
return errResult(call.ID, "sub-agent: "+err.Error())
|
||||
}
|
||||
out := map[string]any{"reply": resp.Reply}
|
||||
b, _ := json.Marshal(out)
|
||||
return ai.ToolResult{ID: call.ID, Value: out, Content: string(b)}
|
||||
}
|
||||
|
||||
// isAgent reports whether name resolves to a registered agent (a
|
||||
// service advertising type=agent in its metadata).
|
||||
func (a *agentImpl) isAgent(name string) bool {
|
||||
if a.opts.Registry == nil {
|
||||
return false
|
||||
}
|
||||
recs, err := a.opts.Registry.GetService(name)
|
||||
if err != nil || len(recs) == 0 {
|
||||
return false
|
||||
}
|
||||
if recs[0].Metadata != nil && recs[0].Metadata["type"] == "agent" {
|
||||
return true
|
||||
}
|
||||
for _, n := range recs[0].Nodes {
|
||||
if n.Metadata != nil && n.Metadata["type"] == "agent" {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// callAgentRPC calls another agent's Agent.Chat endpoint and returns
|
||||
// its reply.
|
||||
func (a *agentImpl) callAgentRPC(ctx context.Context, name, msg string) (string, error) {
|
||||
body, _ := json.Marshal(map[string]string{"message": msg})
|
||||
req := a.opts.Client.NewRequest(name, "Agent.Chat", &codecBytes.Frame{Data: body})
|
||||
var rsp codecBytes.Frame
|
||||
if err := a.opts.Client.Call(ctx, req, &rsp); err != nil {
|
||||
return "", err
|
||||
}
|
||||
var out struct {
|
||||
Reply string `json:"reply"`
|
||||
}
|
||||
if err := json.Unmarshal(rsp.Data, &out); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return out.Reply, nil
|
||||
}
|
||||
|
||||
// planKey is the record key for an agent's plan within its scoped store.
|
||||
const planKey = "plan"
|
||||
|
||||
// loadPlan returns the stored plan as a JSON string, or "" if none.
|
||||
func (a *agentImpl) loadPlan() string {
|
||||
recs, err := a.stateStore().Read(planKey)
|
||||
if err != nil || len(recs) == 0 {
|
||||
return ""
|
||||
}
|
||||
return string(recs[0].Value)
|
||||
}
|
||||
|
||||
func errResult(id, msg string) ai.ToolResult {
|
||||
m := map[string]string{"error": msg}
|
||||
b, _ := json.Marshal(m)
|
||||
return ai.ToolResult{ID: id, Value: m, Content: string(b)}
|
||||
}
|
||||
|
||||
// refused is an error result a guardrail returns, tagged with a structured
|
||||
// reason (ai.Refused*) so a tool wrapper can react to it without parsing
|
||||
// the message.
|
||||
func refused(id, reason, msg string) ai.ToolResult {
|
||||
r := errResult(id, msg)
|
||||
r.Refused = reason
|
||||
return r
|
||||
}
|
||||
@@ -1,167 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
func TestBuiltinTools(t *testing.T) {
|
||||
tools := builtinTools()
|
||||
if len(tools) != 2 {
|
||||
t.Fatalf("builtinTools() = %d tools, want 2", len(tools))
|
||||
}
|
||||
names := map[string]bool{}
|
||||
for _, tl := range tools {
|
||||
names[tl.Name] = true
|
||||
}
|
||||
if !names[toolPlan] || !names[toolDelegate] {
|
||||
t.Errorf("builtin tools = %v, want plan and delegate", names)
|
||||
}
|
||||
}
|
||||
|
||||
func TestHandlePlanPersists(t *testing.T) {
|
||||
mem := store.NewMemoryStore()
|
||||
a := New(Name("planner"), WithStore(mem)).(*agentImpl)
|
||||
|
||||
steps := map[string]any{
|
||||
"steps": []any{
|
||||
map[string]any{"task": "gather requirements", "status": "done"},
|
||||
map[string]any{"task": "write code", "status": "in_progress"},
|
||||
},
|
||||
}
|
||||
content := a.handlePlan(ai.ToolCall{Name: "plan", Input: steps}).Content
|
||||
if content == "" {
|
||||
t.Fatal("handlePlan returned empty content")
|
||||
}
|
||||
|
||||
// The plan must be retrievable from memory.
|
||||
got := a.loadPlan()
|
||||
if got == "" {
|
||||
t.Fatal("loadPlan() returned empty after handlePlan")
|
||||
}
|
||||
var decoded map[string]any
|
||||
if err := json.Unmarshal([]byte(got), &decoded); err != nil {
|
||||
t.Fatalf("stored plan is not valid JSON: %v", err)
|
||||
}
|
||||
if _, ok := decoded["steps"]; !ok {
|
||||
t.Errorf("stored plan missing steps: %s", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestPlanShowsInPrompt(t *testing.T) {
|
||||
mem := store.NewMemoryStore()
|
||||
a := New(Name("planner"), Prompt("base prompt"), WithStore(mem)).(*agentImpl)
|
||||
|
||||
if got := a.buildPrompt(); got != "base prompt" {
|
||||
t.Errorf("buildPrompt() with no plan = %q, want %q", got, "base prompt")
|
||||
}
|
||||
|
||||
a.handlePlan(ai.ToolCall{Name: "plan", Input: map[string]any{"steps": []any{map[string]any{"task": "do it", "status": "pending"}}}})
|
||||
|
||||
got := a.buildPrompt()
|
||||
if got == "base prompt" {
|
||||
t.Error("buildPrompt() should include the plan once one is saved")
|
||||
}
|
||||
if !containsStr(got, "do it") {
|
||||
t.Errorf("buildPrompt() = %q, should contain the saved plan", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestDiscoverToolsIncludesBuiltins(t *testing.T) {
|
||||
reg := registry.NewMemoryRegistry()
|
||||
a := New(Name("a"), WithRegistry(reg), WithStore(store.NewMemoryStore())).(*agentImpl)
|
||||
a.setup()
|
||||
|
||||
tools, err := a.discoverTools()
|
||||
if err != nil {
|
||||
t.Fatalf("discoverTools: %v", err)
|
||||
}
|
||||
// No services registered, so the only tools should be the builtins.
|
||||
if len(tools) != len(builtinTools()) {
|
||||
t.Fatalf("discoverTools() = %d tools, want %d builtins", len(tools), len(builtinTools()))
|
||||
}
|
||||
}
|
||||
|
||||
func TestEphemeralAgentHasNoBuiltins(t *testing.T) {
|
||||
reg := registry.NewMemoryRegistry()
|
||||
a := New(Name("a.sub"), WithRegistry(reg), WithStore(store.NewMemoryStore())).(*agentImpl)
|
||||
a.ephemeral = true
|
||||
a.setup()
|
||||
|
||||
tools, err := a.discoverTools()
|
||||
if err != nil {
|
||||
t.Fatalf("discoverTools: %v", err)
|
||||
}
|
||||
if len(tools) != 0 {
|
||||
t.Errorf("ephemeral agent discoverTools() = %d tools, want 0", len(tools))
|
||||
}
|
||||
}
|
||||
|
||||
func TestBuiltinsAccessor(t *testing.T) {
|
||||
mem := store.NewMemoryStore()
|
||||
tools, handle := Builtins(
|
||||
Name("chat"),
|
||||
WithStore(mem),
|
||||
WithRegistry(registry.NewMemoryRegistry()),
|
||||
)
|
||||
|
||||
if len(tools) != 2 {
|
||||
t.Fatalf("Builtins() returned %d tools, want 2", len(tools))
|
||||
}
|
||||
|
||||
// A name that isn't a built-in falls through (ok == false).
|
||||
if _, _, ok := handle("not_a_builtin", nil); ok {
|
||||
t.Error("handle(non-builtin) ok = true, want false")
|
||||
}
|
||||
|
||||
// plan is handled and persisted under the configured name.
|
||||
_, content, ok := handle(toolPlan, map[string]any{
|
||||
"steps": []any{map[string]any{"task": "x", "status": "pending"}},
|
||||
})
|
||||
if !ok {
|
||||
t.Fatal("handle(plan) ok = false, want true")
|
||||
}
|
||||
if content == "" {
|
||||
t.Fatal("handle(plan) returned empty content")
|
||||
}
|
||||
scoped := store.Scope(mem, "agent", "chat")
|
||||
if recs, err := scoped.Read(planKey); err != nil || len(recs) == 0 {
|
||||
t.Errorf("plan not persisted in the agent's scoped store: err=%v recs=%d", err, len(recs))
|
||||
}
|
||||
}
|
||||
|
||||
func TestIsAgent(t *testing.T) {
|
||||
reg := registry.NewMemoryRegistry()
|
||||
|
||||
// A plain service.
|
||||
if err := reg.Register(®istry.Service{
|
||||
Name: "task",
|
||||
Nodes: []*registry.Node{{Id: "task-1", Address: "127.0.0.1:0"}},
|
||||
}); err != nil {
|
||||
t.Fatalf("register service: %v", err)
|
||||
}
|
||||
// An agent (advertises type=agent).
|
||||
if err := reg.Register(®istry.Service{
|
||||
Name: "task-mgr",
|
||||
Metadata: map[string]string{"type": "agent"},
|
||||
Nodes: []*registry.Node{{Id: "task-mgr-1", Address: "127.0.0.1:0"}},
|
||||
}); err != nil {
|
||||
t.Fatalf("register agent: %v", err)
|
||||
}
|
||||
|
||||
a := New(Name("root"), WithRegistry(reg)).(*agentImpl)
|
||||
|
||||
if a.isAgent("task") {
|
||||
t.Error("isAgent(task) = true, want false (plain service)")
|
||||
}
|
||||
if !a.isAgent("task-mgr") {
|
||||
t.Error("isAgent(task-mgr) = false, want true (agent)")
|
||||
}
|
||||
if a.isAgent("nonexistent") {
|
||||
t.Error("isAgent(nonexistent) = true, want false")
|
||||
}
|
||||
}
|
||||
@@ -1,92 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
// toolContent runs a tool call through a handler and returns the content
|
||||
// shown to the model — the part these tests assert on.
|
||||
func toolContent(h ai.ToolHandler, name string, input map[string]any) string {
|
||||
return h(context.Background(), ai.ToolCall{Name: name, Input: input}).Content
|
||||
}
|
||||
|
||||
// MaxSteps refuses tool calls once the per-Ask limit is exceeded; plan
|
||||
// is bookkeeping and is never counted.
|
||||
func TestMaxStepsStopsActions(t *testing.T) {
|
||||
a := newTestAgent(Name("limited"), MaxSteps(2))
|
||||
|
||||
h := a.toolHandler()
|
||||
|
||||
// plan must not consume a step.
|
||||
a.steps = 0
|
||||
toolContent(h, toolPlan, map[string]any{"steps": []any{}})
|
||||
if a.steps != 0 {
|
||||
t.Fatalf("plan consumed a step: steps=%d", a.steps)
|
||||
}
|
||||
|
||||
// First two actions are allowed (they fall through to RPC, which
|
||||
// fails harmlessly — we only care they weren't refused by the limit).
|
||||
for i := 1; i <= 2; i++ {
|
||||
content := toolContent(h, "demo_Svc_Do", map[string]any{})
|
||||
if strings.Contains(content, "step limit") {
|
||||
t.Fatalf("action %d wrongly hit the step limit", i)
|
||||
}
|
||||
}
|
||||
|
||||
// Third action exceeds MaxSteps(2) and must be refused.
|
||||
content := toolContent(h, "demo_Svc_Do", map[string]any{})
|
||||
if !strings.Contains(content, "step limit") {
|
||||
t.Errorf("third action should hit the step limit; got %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// ApproveTool blocks an action when the hook denies it, and the denial
|
||||
// reason is surfaced to the model.
|
||||
func TestApproveToolBlocks(t *testing.T) {
|
||||
var sawTool string
|
||||
a := newTestAgent(Name("gated"),
|
||||
ApproveTool(func(tool string, input map[string]any) (bool, string) {
|
||||
sawTool = tool
|
||||
return false, "needs sign-off"
|
||||
}),
|
||||
)
|
||||
|
||||
content := toolContent(a.toolHandler(), "demo_Svc_Do", map[string]any{})
|
||||
if sawTool != "demo_Svc_Do" {
|
||||
t.Errorf("approver saw %q, want demo_Svc_Do", sawTool)
|
||||
}
|
||||
if !strings.Contains(content, "not approved") || !strings.Contains(content, "needs sign-off") {
|
||||
t.Errorf("blocked call should surface the reason; got %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// A denying approver must not gate the internal plan tool.
|
||||
func TestApproveToolDoesNotGatePlan(t *testing.T) {
|
||||
mem := store.NewMemoryStore()
|
||||
a := New(
|
||||
Name("gated"),
|
||||
Provider("fake"),
|
||||
WithRegistry(registry.NewMemoryRegistry()),
|
||||
WithStore(mem),
|
||||
ApproveTool(func(tool string, input map[string]any) (bool, string) {
|
||||
return false, "deny everything"
|
||||
}),
|
||||
).(*agentImpl)
|
||||
a.setup()
|
||||
|
||||
content := toolContent(a.toolHandler(), toolPlan, map[string]any{
|
||||
"steps": []any{map[string]any{"task": "x", "status": "pending"}},
|
||||
})
|
||||
if strings.Contains(content, "not approved") {
|
||||
t.Errorf("plan must not be gated by ApproveTool; got %q", content)
|
||||
}
|
||||
if recs, _ := store.Scope(mem, "agent", "gated").Read(planKey); len(recs) == 0 {
|
||||
t.Error("plan should have been persisted despite the denying approver")
|
||||
}
|
||||
}
|
||||
@@ -1,181 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/client"
|
||||
codecBytes "go-micro.dev/v6/codec/bytes"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
// fakeGen drives the fake provider's Generate. Tests set it and reset
|
||||
// it with a deferred cleanup. Tests in this package are not parallel,
|
||||
// so a package-level hook is safe.
|
||||
var fakeGen func(opts ai.Options, req *ai.Request) (*ai.Response, error)
|
||||
|
||||
type fakeModel struct{ opts ai.Options }
|
||||
|
||||
func (m *fakeModel) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&m.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
func (m *fakeModel) Options() ai.Options { return m.opts }
|
||||
func (m *fakeModel) Generate(ctx context.Context, req *ai.Request, _ ...ai.GenerateOption) (*ai.Response, error) {
|
||||
if fakeGen != nil {
|
||||
return fakeGen(m.opts, req)
|
||||
}
|
||||
return &ai.Response{Reply: "ok"}, nil
|
||||
}
|
||||
func (m *fakeModel) Stream(ctx context.Context, req *ai.Request, _ ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, nil
|
||||
}
|
||||
func (m *fakeModel) String() string { return "fake" }
|
||||
|
||||
func init() {
|
||||
ai.Register("fake", func(opts ...ai.Option) ai.Model {
|
||||
m := &fakeModel{}
|
||||
_ = m.Init(opts...)
|
||||
return m
|
||||
})
|
||||
}
|
||||
|
||||
// fakeClient embeds the default client (so NewRequest works) and
|
||||
// overrides Call with a test-supplied function.
|
||||
type fakeClient struct {
|
||||
client.Client
|
||||
callFn func(ctx context.Context, req client.Request, rsp interface{}) error
|
||||
}
|
||||
|
||||
func (c *fakeClient) Call(ctx context.Context, req client.Request, rsp interface{}, opts ...client.CallOption) error {
|
||||
return c.callFn(ctx, req, rsp)
|
||||
}
|
||||
|
||||
func newTestAgent(opts ...Option) *agentImpl {
|
||||
base := []Option{
|
||||
Provider("fake"),
|
||||
WithRegistry(registry.NewMemoryRegistry()),
|
||||
WithStore(store.NewMemoryStore()),
|
||||
}
|
||||
a := New(append(base, opts...)...).(*agentImpl)
|
||||
a.setup()
|
||||
return a
|
||||
}
|
||||
|
||||
// The model is offered the plan and delegate tools, and calling the
|
||||
// plan tool persists the plan to memory.
|
||||
func TestAskExposesAndRunsPlan(t *testing.T) {
|
||||
var sawPlan, sawDelegate bool
|
||||
fakeGen = func(opts ai.Options, req *ai.Request) (*ai.Response, error) {
|
||||
for _, tl := range req.Tools {
|
||||
switch tl.Name {
|
||||
case toolPlan:
|
||||
sawPlan = true
|
||||
case toolDelegate:
|
||||
sawDelegate = true
|
||||
}
|
||||
}
|
||||
// Simulate the model recording a plan.
|
||||
if opts.ToolHandler != nil {
|
||||
opts.ToolHandler(context.Background(), ai.ToolCall{
|
||||
Name: toolPlan,
|
||||
Input: map[string]any{
|
||||
"steps": []any{map[string]any{"task": "step one", "status": "pending"}},
|
||||
},
|
||||
})
|
||||
}
|
||||
return &ai.Response{Answer: "done"}, nil
|
||||
}
|
||||
defer func() { fakeGen = nil }()
|
||||
|
||||
a := newTestAgent(Name("worker"))
|
||||
resp, err := a.Ask(context.Background(), "do some multi-step work")
|
||||
if err != nil {
|
||||
t.Fatalf("Ask: %v", err)
|
||||
}
|
||||
if !sawPlan || !sawDelegate {
|
||||
t.Errorf("model should be offered plan and delegate tools: plan=%v delegate=%v", sawPlan, sawDelegate)
|
||||
}
|
||||
if resp.Reply == "" {
|
||||
t.Error("Ask returned empty reply")
|
||||
}
|
||||
if plan := a.loadPlan(); !strings.Contains(plan, "step one") {
|
||||
t.Errorf("plan tool result not persisted; loadPlan() = %q", plan)
|
||||
}
|
||||
}
|
||||
|
||||
// Delegating with no matching agent creates an ephemeral sub-agent with
|
||||
// a fresh, isolated context (no builtin tools) and returns its reply.
|
||||
func TestDelegateEphemeral(t *testing.T) {
|
||||
fakeGen = func(opts ai.Options, req *ai.Request) (*ai.Response, error) {
|
||||
if strings.Contains(req.SystemPrompt, "sub-agent") {
|
||||
for _, tl := range req.Tools {
|
||||
if tl.Name == toolPlan || tl.Name == toolDelegate {
|
||||
t.Errorf("ephemeral sub-agent must not have builtin tool %q", tl.Name)
|
||||
}
|
||||
}
|
||||
return &ai.Response{Reply: "subtask complete"}, nil
|
||||
}
|
||||
return &ai.Response{Reply: "parent"}, nil
|
||||
}
|
||||
defer func() { fakeGen = nil }()
|
||||
|
||||
a := newTestAgent(Name("root"))
|
||||
content := a.handleDelegate(ai.ToolCall{Name: "delegate", Input: map[string]any{"task": "summarize the report"}}).Content
|
||||
if !strings.Contains(content, "subtask complete") {
|
||||
t.Errorf("delegate should return the sub-agent's reply; got %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// Delegating to a name that resolves to a registered agent goes over
|
||||
// RPC to that agent rather than spawning a sub-agent.
|
||||
func TestDelegateToRegisteredAgent(t *testing.T) {
|
||||
reg := registry.NewMemoryRegistry()
|
||||
if err := reg.Register(®istry.Service{
|
||||
Name: "comms",
|
||||
Metadata: map[string]string{"type": "agent"},
|
||||
Nodes: []*registry.Node{{Id: "comms-1", Address: "127.0.0.1:0"}},
|
||||
}); err != nil {
|
||||
t.Fatalf("register agent: %v", err)
|
||||
}
|
||||
|
||||
var calledService, calledEndpoint string
|
||||
fc := &fakeClient{Client: client.DefaultClient}
|
||||
fc.callFn = func(ctx context.Context, req client.Request, rsp interface{}) error {
|
||||
calledService, calledEndpoint = req.Service(), req.Endpoint()
|
||||
frame := rsp.(*codecBytes.Frame)
|
||||
frame.Data = []byte(`{"reply":"notified alice","agent":"comms"}`)
|
||||
return nil
|
||||
}
|
||||
|
||||
// fakeGen guards against the ephemeral path being taken by mistake.
|
||||
fakeGen = func(opts ai.Options, req *ai.Request) (*ai.Response, error) {
|
||||
t.Error("delegate to a registered agent must not spawn a sub-agent")
|
||||
return &ai.Response{}, nil
|
||||
}
|
||||
defer func() { fakeGen = nil }()
|
||||
|
||||
a := newTestAgent(Name("root"), WithRegistry(reg), WithClient(fc))
|
||||
content := a.handleDelegate(ai.ToolCall{Name: "delegate", Input: map[string]any{"task": "notify alice", "to": "comms"}}).Content
|
||||
|
||||
if calledService != "comms" || calledEndpoint != "Agent.Chat" {
|
||||
t.Errorf("expected RPC to comms Agent.Chat, got %s %s", calledService, calledEndpoint)
|
||||
}
|
||||
if !strings.Contains(content, "notified alice") {
|
||||
t.Errorf("delegate-first result missing agent reply; got %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// Delegate requires a task.
|
||||
func TestDelegateRequiresTask(t *testing.T) {
|
||||
a := newTestAgent(Name("root"))
|
||||
content := a.handleDelegate(ai.ToolCall{Name: "delegate", Input: map[string]any{}}).Content
|
||||
if !strings.Contains(content, "error") {
|
||||
t.Errorf("delegate with no task should error; got %q", content)
|
||||
}
|
||||
}
|
||||
@@ -1,71 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// Repeating the same tool call with the same arguments is refused once it
|
||||
// exceeds LoopLimit, and the model is told to change approach.
|
||||
func TestLoopDetectionStopsRepeats(t *testing.T) {
|
||||
a := newTestAgent(Name("looper"), LoopLimit(3))
|
||||
h := a.toolHandler()
|
||||
|
||||
// First 3 identical calls are allowed (they fall through to RPC,
|
||||
// which fails harmlessly — we only care they weren't refused as loops).
|
||||
for i := 1; i <= 3; i++ {
|
||||
content := toolContent(h, "demo_Svc_Do", map[string]any{"q": "x"})
|
||||
if strings.Contains(content, "loop detected") {
|
||||
t.Fatalf("call %d wrongly flagged as a loop", i)
|
||||
}
|
||||
}
|
||||
|
||||
// The 4th identical call is refused as a loop.
|
||||
content := toolContent(h, "demo_Svc_Do", map[string]any{"q": "x"})
|
||||
if !strings.Contains(content, "loop detected") {
|
||||
t.Errorf("4th identical call should be refused as a loop; got %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// Different arguments are not a loop, even past the limit.
|
||||
func TestLoopDetectionAllowsDistinctCalls(t *testing.T) {
|
||||
a := newTestAgent(Name("distinct"), LoopLimit(2))
|
||||
h := a.toolHandler()
|
||||
|
||||
for i := 0; i < 5; i++ {
|
||||
content := toolContent(h, "demo_Svc_Do", map[string]any{"q": i}) // distinct args each time
|
||||
if strings.Contains(content, "loop detected") {
|
||||
t.Fatalf("distinct call %d wrongly flagged as a loop", i)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// LoopLimit(0) disables detection.
|
||||
func TestLoopDetectionDisabled(t *testing.T) {
|
||||
a := newTestAgent(Name("noloop"), LoopLimit(0))
|
||||
h := a.toolHandler()
|
||||
for i := 0; i < 6; i++ {
|
||||
content := toolContent(h, "demo_Svc_Do", map[string]any{"q": "same"})
|
||||
if strings.Contains(content, "loop detected") {
|
||||
t.Fatalf("loop detection should be disabled with LoopLimit(0)")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// It defaults on (lenient) so repeated identical calls are caught without
|
||||
// any configuration.
|
||||
func TestLoopDetectionDefaultOn(t *testing.T) {
|
||||
a := New(Name("d"), Provider("fake")).(*agentImpl)
|
||||
a.setup()
|
||||
if a.opts.LoopLimit <= 0 {
|
||||
t.Fatalf("LoopLimit should default on, got %d", a.opts.LoopLimit)
|
||||
}
|
||||
h := a.toolHandler()
|
||||
var lastContent string
|
||||
for i := 0; i < a.opts.LoopLimit+1; i++ {
|
||||
lastContent = toolContent(h, "demo_Svc_Do", map[string]any{})
|
||||
}
|
||||
if !strings.Contains(lastContent, "loop detected") {
|
||||
t.Errorf("default loop detection should catch repeated calls; got %q", lastContent)
|
||||
}
|
||||
}
|
||||
@@ -1,98 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"sync"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
// Memory is an agent's conversation memory. Like the rest of the
|
||||
// framework it is pluggable: the default is store-backed and durable
|
||||
// across restarts, but any implementation can be supplied with
|
||||
// WithMemory — in-process, a database, or a semantic/vector store.
|
||||
type Memory interface {
|
||||
// Add appends a message to the conversation.
|
||||
Add(role, content string)
|
||||
// Messages returns the retained conversation, oldest first.
|
||||
Messages() []ai.Message
|
||||
// Clear resets the conversation.
|
||||
Clear()
|
||||
}
|
||||
|
||||
// NewMemory returns the default store-backed memory: an in-process
|
||||
// conversation buffer (truncated to limit) that persists to the store
|
||||
// under key, so an agent picks up where it left off after a restart.
|
||||
// A nil store or empty key yields non-persistent memory.
|
||||
func NewMemory(s store.Store, key string, limit int) Memory {
|
||||
m := &storeMemory{store: s, key: key, hist: ai.NewHistory(limit)}
|
||||
m.load()
|
||||
return m
|
||||
}
|
||||
|
||||
// NewInMemory returns conversation memory that is not persisted.
|
||||
func NewInMemory(limit int) Memory {
|
||||
return &storeMemory{hist: ai.NewHistory(limit)}
|
||||
}
|
||||
|
||||
// storeMemory is the default Memory: an ai.History buffer optionally
|
||||
// persisted to a store.
|
||||
type storeMemory struct {
|
||||
mu sync.Mutex
|
||||
store store.Store
|
||||
key string
|
||||
hist *ai.History
|
||||
}
|
||||
|
||||
func (m *storeMemory) Add(role, content string) {
|
||||
m.mu.Lock()
|
||||
m.hist.Add(role, content)
|
||||
m.mu.Unlock()
|
||||
m.save()
|
||||
}
|
||||
|
||||
func (m *storeMemory) Messages() []ai.Message {
|
||||
m.mu.Lock()
|
||||
defer m.mu.Unlock()
|
||||
return m.hist.Messages()
|
||||
}
|
||||
|
||||
func (m *storeMemory) Clear() {
|
||||
m.mu.Lock()
|
||||
m.hist.Reset()
|
||||
m.mu.Unlock()
|
||||
m.save()
|
||||
}
|
||||
|
||||
func (m *storeMemory) load() {
|
||||
if m.store == nil || m.key == "" {
|
||||
return
|
||||
}
|
||||
recs, err := m.store.Read(m.key)
|
||||
if err != nil || len(recs) == 0 {
|
||||
return
|
||||
}
|
||||
var msgs []ai.Message
|
||||
if err := json.Unmarshal(recs[0].Value, &msgs); err != nil {
|
||||
return
|
||||
}
|
||||
m.mu.Lock()
|
||||
for _, msg := range msgs {
|
||||
m.hist.Add(msg.Role, msg.Content)
|
||||
}
|
||||
m.mu.Unlock()
|
||||
}
|
||||
|
||||
func (m *storeMemory) save() {
|
||||
if m.store == nil || m.key == "" {
|
||||
return
|
||||
}
|
||||
m.mu.Lock()
|
||||
data, err := json.Marshal(m.hist.Messages())
|
||||
m.mu.Unlock()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
m.store.Write(&store.Record{Key: m.key, Value: data})
|
||||
}
|
||||
@@ -1,114 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
func TestStoreMemoryPersists(t *testing.T) {
|
||||
st := store.NewMemoryStore()
|
||||
m := NewMemory(st, "agent/x/history", 10)
|
||||
m.Add("user", "hello")
|
||||
m.Add("assistant", "hi there")
|
||||
|
||||
// A fresh memory over the same store/key restores the conversation.
|
||||
reloaded := NewMemory(st, "agent/x/history", 10)
|
||||
if got := len(reloaded.Messages()); got != 2 {
|
||||
t.Fatalf("restored %d messages, want 2", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestInMemoryNotPersisted(t *testing.T) {
|
||||
m := NewInMemory(10)
|
||||
m.Add("user", "x")
|
||||
if got := len(m.Messages()); got != 1 {
|
||||
t.Fatalf("got %d messages, want 1", got)
|
||||
}
|
||||
if got := len(NewInMemory(10).Messages()); got != 0 {
|
||||
t.Errorf("a separate in-memory should be empty, got %d", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMemoryClearPersists(t *testing.T) {
|
||||
st := store.NewMemoryStore()
|
||||
m := NewMemory(st, "agent/y/history", 10)
|
||||
m.Add("user", "x")
|
||||
m.Clear()
|
||||
if got := len(m.Messages()); got != 0 {
|
||||
t.Errorf("after Clear got %d messages, want 0", got)
|
||||
}
|
||||
if got := len(NewMemory(st, "agent/y/history", 10).Messages()); got != 0 {
|
||||
t.Errorf("cleared state should persist, reload got %d", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestWithMemoryUsed(t *testing.T) {
|
||||
custom := NewInMemory(5)
|
||||
a := New(
|
||||
Name("z"),
|
||||
Provider("fake"),
|
||||
WithRegistry(registry.NewMemoryRegistry()),
|
||||
WithStore(store.NewMemoryStore()),
|
||||
WithMemory(custom),
|
||||
).(*agentImpl)
|
||||
a.setup()
|
||||
if a.mem != custom {
|
||||
t.Error("WithMemory should make the agent use the supplied memory")
|
||||
}
|
||||
}
|
||||
|
||||
// A custom tool is offered to the model and dispatched to its handler.
|
||||
func TestWithToolExposedAndDispatched(t *testing.T) {
|
||||
var got map[string]any
|
||||
a := newTestAgent(Name("calc-agent"),
|
||||
WithTool("calc", "adds two numbers",
|
||||
map[string]any{
|
||||
"a": map[string]any{"type": "number"},
|
||||
"b": map[string]any{"type": "number"},
|
||||
},
|
||||
func(ctx context.Context, input map[string]any) (string, error) {
|
||||
got = input
|
||||
return `{"sum":3}`, nil
|
||||
}))
|
||||
|
||||
tools, err := a.discoverTools()
|
||||
if err != nil {
|
||||
t.Fatalf("discoverTools: %v", err)
|
||||
}
|
||||
found := false
|
||||
for _, tl := range tools {
|
||||
if tl.Name == "calc" {
|
||||
found = true
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
t.Fatal("custom tool 'calc' was not offered to the model")
|
||||
}
|
||||
|
||||
content := toolContent(a.toolHandler(), "calc", map[string]any{"a": 1.0, "b": 2.0})
|
||||
if got == nil {
|
||||
t.Fatal("custom tool handler was not called")
|
||||
}
|
||||
if !strings.Contains(content, "sum") {
|
||||
t.Errorf("custom tool result not returned: %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// A custom tool returning an error surfaces it to the model.
|
||||
func TestWithToolError(t *testing.T) {
|
||||
a := newTestAgent(Name("err-agent"),
|
||||
WithTool("boom", "always fails", nil,
|
||||
func(ctx context.Context, input map[string]any) (string, error) {
|
||||
return "", errors.New("kaboom")
|
||||
}))
|
||||
|
||||
content := toolContent(a.toolHandler(), "boom", nil)
|
||||
if !strings.Contains(content, "kaboom") {
|
||||
t.Errorf("tool error not surfaced: %q", content)
|
||||
}
|
||||
}
|
||||
@@ -1,210 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
// Option configures an Agent.
|
||||
type Option func(*Options)
|
||||
|
||||
// ApproveFunc decides whether an agent may execute a tool call before it
|
||||
// runs. Returning false blocks the call; the reason is shown to the
|
||||
// model so it can adapt. Use it for human-in-the-loop approval or policy
|
||||
// checks. It is called for actions (service tools and delegate), not for
|
||||
// the internal plan tool.
|
||||
type ApproveFunc func(tool string, input map[string]any) (approved bool, reason string)
|
||||
|
||||
// ToolFunc handles a custom tool call. Return the result as a string
|
||||
// (often JSON); return an error to report failure back to the model.
|
||||
type ToolFunc func(ctx context.Context, input map[string]any) (string, error)
|
||||
|
||||
// customTool is a developer-registered tool beyond the agent's services.
|
||||
type customTool struct {
|
||||
def ai.Tool
|
||||
handler ToolFunc
|
||||
}
|
||||
|
||||
// Options holds agent configuration.
|
||||
type Options struct {
|
||||
Name string
|
||||
Services []string
|
||||
Prompt string
|
||||
Provider string
|
||||
Model string
|
||||
APIKey string
|
||||
Registry registry.Registry
|
||||
Client client.Client
|
||||
Store store.Store
|
||||
HistoryLimit int
|
||||
|
||||
// Memory is the agent's conversation memory. Nil = the default
|
||||
// store-backed memory (durable across restarts).
|
||||
Memory Memory
|
||||
|
||||
// MaxSteps bounds the number of tool executions per Ask (0 =
|
||||
// unbounded). Once exceeded, further tool calls are refused and the
|
||||
// model is told to stop and summarize. A stopping condition.
|
||||
MaxSteps int
|
||||
// LoopLimit bounds how many times the agent may call the same tool
|
||||
// with the same arguments in one Ask before the call is refused as a
|
||||
// no-progress loop (0 = disabled). Catches the agent repeating an
|
||||
// identical action — which MaxSteps only bounds by total count.
|
||||
LoopLimit int
|
||||
// Approve gates each action before it runs. Nil = allow all.
|
||||
Approve ApproveFunc
|
||||
|
||||
// A2AAddress, if set, makes Run serve this agent over the A2A protocol
|
||||
// on that address directly (no separate gateway), e.g. ":4000".
|
||||
A2AAddress string
|
||||
|
||||
// tools are developer-registered custom tools (see WithTool).
|
||||
tools []customTool
|
||||
// wrappers are developer-registered tool-execution wrappers
|
||||
// (see WrapTool), applied outside the built-in guardrails.
|
||||
wrappers []ai.ToolWrapper
|
||||
}
|
||||
|
||||
func newOptions(opts ...Option) Options {
|
||||
o := Options{
|
||||
Registry: registry.DefaultRegistry,
|
||||
Client: client.DefaultClient,
|
||||
Store: store.DefaultStore,
|
||||
HistoryLimit: 50,
|
||||
// On by default and lenient: identical repeated calls are a
|
||||
// no-progress loop, never useful. Set LoopLimit(0) to disable.
|
||||
LoopLimit: 3,
|
||||
}
|
||||
for _, opt := range opts {
|
||||
opt(&o)
|
||||
}
|
||||
return o
|
||||
}
|
||||
|
||||
// Name sets the agent name.
|
||||
func Name(n string) Option {
|
||||
return func(o *Options) { o.Name = n }
|
||||
}
|
||||
|
||||
// Services sets which services this agent manages.
|
||||
func Services(names ...string) Option {
|
||||
return func(o *Options) { o.Services = names }
|
||||
}
|
||||
|
||||
// Prompt sets the system prompt.
|
||||
func Prompt(p string) Option {
|
||||
return func(o *Options) { o.Prompt = p }
|
||||
}
|
||||
|
||||
// Provider sets the LLM provider.
|
||||
func Provider(p string) Option {
|
||||
return func(o *Options) { o.Provider = p }
|
||||
}
|
||||
|
||||
// Model sets the LLM model name.
|
||||
func Model(m string) Option {
|
||||
return func(o *Options) { o.Model = m }
|
||||
}
|
||||
|
||||
// APIKey sets the API key for the LLM provider.
|
||||
func APIKey(k string) Option {
|
||||
return func(o *Options) { o.APIKey = k }
|
||||
}
|
||||
|
||||
// WithRegistry sets the service registry.
|
||||
func WithRegistry(r registry.Registry) Option {
|
||||
return func(o *Options) { o.Registry = r }
|
||||
}
|
||||
|
||||
// WithClient sets the RPC client.
|
||||
func WithClient(c client.Client) Option {
|
||||
return func(o *Options) { o.Client = c }
|
||||
}
|
||||
|
||||
// WithStore sets the store for agent memory.
|
||||
func WithStore(s store.Store) Option {
|
||||
return func(o *Options) { o.Store = s }
|
||||
}
|
||||
|
||||
// HistoryLimit sets the max conversation messages to retain.
|
||||
func HistoryLimit(n int) Option {
|
||||
return func(o *Options) { o.HistoryLimit = n }
|
||||
}
|
||||
|
||||
// MaxSteps bounds tool executions per Ask (0 = unbounded). A stopping
|
||||
// condition: beyond the limit, tool calls are refused and the model is
|
||||
// told to stop and summarize.
|
||||
func MaxSteps(n int) Option {
|
||||
return func(o *Options) { o.MaxSteps = n }
|
||||
}
|
||||
|
||||
// ApproveTool sets a human-in-the-loop / policy hook called before each
|
||||
// action (service tools and delegate). Returning false blocks the call.
|
||||
func ApproveTool(fn ApproveFunc) Option {
|
||||
return func(o *Options) { o.Approve = fn }
|
||||
}
|
||||
|
||||
// LoopLimit sets how many times the agent may repeat the same tool call
|
||||
// (same name and arguments) in one Ask before it is refused as a
|
||||
// no-progress loop. 0 disables loop detection.
|
||||
func LoopLimit(n int) Option {
|
||||
return func(o *Options) { o.LoopLimit = n }
|
||||
}
|
||||
|
||||
// WithA2A makes Run serve the agent over the A2A protocol on addr (e.g.
|
||||
// ":4000"), so other agents can reach it directly by URL without a
|
||||
// separate gateway. The agent stays a normal go-micro service as well;
|
||||
// this adds a second, A2A-native HTTP endpoint that calls it in-process.
|
||||
func WithA2A(addr string) Option {
|
||||
return func(o *Options) { o.A2AAddress = addr }
|
||||
}
|
||||
|
||||
// WithMemory sets the agent's conversation memory. The default is
|
||||
// store-backed memory keyed by agent name; supply your own to use an
|
||||
// in-process, database, or semantic store.
|
||||
func WithMemory(m Memory) Option {
|
||||
return func(o *Options) { o.Memory = m }
|
||||
}
|
||||
|
||||
// WrapTool registers a tool-execution wrapper, the tool-side analogue of
|
||||
// a client/server middleware wrapper. Each wrapper takes the next handler
|
||||
// and returns a new one; code before the next(...) call runs before the
|
||||
// tool executes, code after runs after. Use it for logging, metrics,
|
||||
// retries, or custom policy. Wrappers run outside the built-in guardrails
|
||||
// (MaxSteps, LoopLimit, ApproveTool), so they observe every call and its
|
||||
// result, including refusals. Multiple wrappers compose outermost-first.
|
||||
//
|
||||
// micro.NewAgent("worker", micro.AgentWrapTool(
|
||||
// func(next ai.ToolHandler) ai.ToolHandler {
|
||||
// return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
// res := next(ctx, call)
|
||||
// log.Printf("id=%s tool=%s", call.ID, call.Name)
|
||||
// return res
|
||||
// }
|
||||
// }))
|
||||
func WrapTool(w ...ai.ToolWrapper) Option {
|
||||
return func(o *Options) {
|
||||
o.wrappers = append(o.wrappers, w...)
|
||||
}
|
||||
}
|
||||
|
||||
// WithTool registers a custom tool the agent can call, beyond the
|
||||
// services it discovers — a local function, an external API, anything.
|
||||
// properties is the JSON-schema map for the tool's parameters.
|
||||
func WithTool(name, description string, properties map[string]any, handler ToolFunc) Option {
|
||||
return func(o *Options) {
|
||||
o.tools = append(o.tools, customTool{
|
||||
def: ai.Tool{
|
||||
Name: name,
|
||||
OriginalName: name,
|
||||
Description: description,
|
||||
Properties: properties,
|
||||
},
|
||||
handler: handler,
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -1,267 +0,0 @@
|
||||
// Code generated by protoc-gen-go. DO NOT EDIT.
|
||||
// versions:
|
||||
// protoc-gen-go v1.36.11
|
||||
// protoc v3.21.12
|
||||
// source: proto/agent.proto
|
||||
|
||||
package agent
|
||||
|
||||
import (
|
||||
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
|
||||
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
|
||||
reflect "reflect"
|
||||
sync "sync"
|
||||
unsafe "unsafe"
|
||||
)
|
||||
|
||||
const (
|
||||
// Verify that this generated code is sufficiently up-to-date.
|
||||
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
|
||||
// Verify that runtime/protoimpl is sufficiently up-to-date.
|
||||
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
|
||||
)
|
||||
|
||||
type ChatRequest struct {
|
||||
state protoimpl.MessageState `protogen:"open.v1"`
|
||||
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
|
||||
unknownFields protoimpl.UnknownFields
|
||||
sizeCache protoimpl.SizeCache
|
||||
}
|
||||
|
||||
func (x *ChatRequest) Reset() {
|
||||
*x = ChatRequest{}
|
||||
mi := &file_proto_agent_proto_msgTypes[0]
|
||||
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||
ms.StoreMessageInfo(mi)
|
||||
}
|
||||
|
||||
func (x *ChatRequest) String() string {
|
||||
return protoimpl.X.MessageStringOf(x)
|
||||
}
|
||||
|
||||
func (*ChatRequest) ProtoMessage() {}
|
||||
|
||||
func (x *ChatRequest) ProtoReflect() protoreflect.Message {
|
||||
mi := &file_proto_agent_proto_msgTypes[0]
|
||||
if x != nil {
|
||||
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||
if ms.LoadMessageInfo() == nil {
|
||||
ms.StoreMessageInfo(mi)
|
||||
}
|
||||
return ms
|
||||
}
|
||||
return mi.MessageOf(x)
|
||||
}
|
||||
|
||||
// Deprecated: Use ChatRequest.ProtoReflect.Descriptor instead.
|
||||
func (*ChatRequest) Descriptor() ([]byte, []int) {
|
||||
return file_proto_agent_proto_rawDescGZIP(), []int{0}
|
||||
}
|
||||
|
||||
func (x *ChatRequest) GetMessage() string {
|
||||
if x != nil {
|
||||
return x.Message
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
type ChatResponse struct {
|
||||
state protoimpl.MessageState `protogen:"open.v1"`
|
||||
Reply string `protobuf:"bytes,1,opt,name=reply,proto3" json:"reply,omitempty"`
|
||||
Agent string `protobuf:"bytes,2,opt,name=agent,proto3" json:"agent,omitempty"`
|
||||
ToolCalls []*ToolCall `protobuf:"bytes,3,rep,name=tool_calls,json=toolCalls,proto3" json:"tool_calls,omitempty"`
|
||||
unknownFields protoimpl.UnknownFields
|
||||
sizeCache protoimpl.SizeCache
|
||||
}
|
||||
|
||||
func (x *ChatResponse) Reset() {
|
||||
*x = ChatResponse{}
|
||||
mi := &file_proto_agent_proto_msgTypes[1]
|
||||
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||
ms.StoreMessageInfo(mi)
|
||||
}
|
||||
|
||||
func (x *ChatResponse) String() string {
|
||||
return protoimpl.X.MessageStringOf(x)
|
||||
}
|
||||
|
||||
func (*ChatResponse) ProtoMessage() {}
|
||||
|
||||
func (x *ChatResponse) ProtoReflect() protoreflect.Message {
|
||||
mi := &file_proto_agent_proto_msgTypes[1]
|
||||
if x != nil {
|
||||
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||
if ms.LoadMessageInfo() == nil {
|
||||
ms.StoreMessageInfo(mi)
|
||||
}
|
||||
return ms
|
||||
}
|
||||
return mi.MessageOf(x)
|
||||
}
|
||||
|
||||
// Deprecated: Use ChatResponse.ProtoReflect.Descriptor instead.
|
||||
func (*ChatResponse) Descriptor() ([]byte, []int) {
|
||||
return file_proto_agent_proto_rawDescGZIP(), []int{1}
|
||||
}
|
||||
|
||||
func (x *ChatResponse) GetReply() string {
|
||||
if x != nil {
|
||||
return x.Reply
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x *ChatResponse) GetAgent() string {
|
||||
if x != nil {
|
||||
return x.Agent
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x *ChatResponse) GetToolCalls() []*ToolCall {
|
||||
if x != nil {
|
||||
return x.ToolCalls
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
type ToolCall struct {
|
||||
state protoimpl.MessageState `protogen:"open.v1"`
|
||||
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
|
||||
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
|
||||
Input string `protobuf:"bytes,3,opt,name=input,proto3" json:"input,omitempty"`
|
||||
Result string `protobuf:"bytes,4,opt,name=result,proto3" json:"result,omitempty"`
|
||||
unknownFields protoimpl.UnknownFields
|
||||
sizeCache protoimpl.SizeCache
|
||||
}
|
||||
|
||||
func (x *ToolCall) Reset() {
|
||||
*x = ToolCall{}
|
||||
mi := &file_proto_agent_proto_msgTypes[2]
|
||||
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||
ms.StoreMessageInfo(mi)
|
||||
}
|
||||
|
||||
func (x *ToolCall) String() string {
|
||||
return protoimpl.X.MessageStringOf(x)
|
||||
}
|
||||
|
||||
func (*ToolCall) ProtoMessage() {}
|
||||
|
||||
func (x *ToolCall) ProtoReflect() protoreflect.Message {
|
||||
mi := &file_proto_agent_proto_msgTypes[2]
|
||||
if x != nil {
|
||||
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
|
||||
if ms.LoadMessageInfo() == nil {
|
||||
ms.StoreMessageInfo(mi)
|
||||
}
|
||||
return ms
|
||||
}
|
||||
return mi.MessageOf(x)
|
||||
}
|
||||
|
||||
// Deprecated: Use ToolCall.ProtoReflect.Descriptor instead.
|
||||
func (*ToolCall) Descriptor() ([]byte, []int) {
|
||||
return file_proto_agent_proto_rawDescGZIP(), []int{2}
|
||||
}
|
||||
|
||||
func (x *ToolCall) GetId() string {
|
||||
if x != nil {
|
||||
return x.Id
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x *ToolCall) GetName() string {
|
||||
if x != nil {
|
||||
return x.Name
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x *ToolCall) GetInput() string {
|
||||
if x != nil {
|
||||
return x.Input
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func (x *ToolCall) GetResult() string {
|
||||
if x != nil {
|
||||
return x.Result
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
var File_proto_agent_proto protoreflect.FileDescriptor
|
||||
|
||||
const file_proto_agent_proto_rawDesc = "" +
|
||||
"\n" +
|
||||
"\x11proto/agent.proto\x12\x05agent\"'\n" +
|
||||
"\vChatRequest\x12\x18\n" +
|
||||
"\amessage\x18\x01 \x01(\tR\amessage\"j\n" +
|
||||
"\fChatResponse\x12\x14\n" +
|
||||
"\x05reply\x18\x01 \x01(\tR\x05reply\x12\x14\n" +
|
||||
"\x05agent\x18\x02 \x01(\tR\x05agent\x12.\n" +
|
||||
"\n" +
|
||||
"tool_calls\x18\x03 \x03(\v2\x0f.agent.ToolCallR\ttoolCalls\"\\\n" +
|
||||
"\bToolCall\x12\x0e\n" +
|
||||
"\x02id\x18\x01 \x01(\tR\x02id\x12\x12\n" +
|
||||
"\x04name\x18\x02 \x01(\tR\x04name\x12\x14\n" +
|
||||
"\x05input\x18\x03 \x01(\tR\x05input\x12\x16\n" +
|
||||
"\x06result\x18\x04 \x01(\tR\x06result2:\n" +
|
||||
"\x05Agent\x121\n" +
|
||||
"\x04Chat\x12\x12.agent.ChatRequest\x1a\x13.agent.ChatResponse\"\x00B\x0fZ\r./proto;agentb\x06proto3"
|
||||
|
||||
var (
|
||||
file_proto_agent_proto_rawDescOnce sync.Once
|
||||
file_proto_agent_proto_rawDescData []byte
|
||||
)
|
||||
|
||||
func file_proto_agent_proto_rawDescGZIP() []byte {
|
||||
file_proto_agent_proto_rawDescOnce.Do(func() {
|
||||
file_proto_agent_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_proto_agent_proto_rawDesc), len(file_proto_agent_proto_rawDesc)))
|
||||
})
|
||||
return file_proto_agent_proto_rawDescData
|
||||
}
|
||||
|
||||
var file_proto_agent_proto_msgTypes = make([]protoimpl.MessageInfo, 3)
|
||||
var file_proto_agent_proto_goTypes = []any{
|
||||
(*ChatRequest)(nil), // 0: agent.ChatRequest
|
||||
(*ChatResponse)(nil), // 1: agent.ChatResponse
|
||||
(*ToolCall)(nil), // 2: agent.ToolCall
|
||||
}
|
||||
var file_proto_agent_proto_depIdxs = []int32{
|
||||
2, // 0: agent.ChatResponse.tool_calls:type_name -> agent.ToolCall
|
||||
0, // 1: agent.Agent.Chat:input_type -> agent.ChatRequest
|
||||
1, // 2: agent.Agent.Chat:output_type -> agent.ChatResponse
|
||||
2, // [2:3] is the sub-list for method output_type
|
||||
1, // [1:2] is the sub-list for method input_type
|
||||
1, // [1:1] is the sub-list for extension type_name
|
||||
1, // [1:1] is the sub-list for extension extendee
|
||||
0, // [0:1] is the sub-list for field type_name
|
||||
}
|
||||
|
||||
func init() { file_proto_agent_proto_init() }
|
||||
func file_proto_agent_proto_init() {
|
||||
if File_proto_agent_proto != nil {
|
||||
return
|
||||
}
|
||||
type x struct{}
|
||||
out := protoimpl.TypeBuilder{
|
||||
File: protoimpl.DescBuilder{
|
||||
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
|
||||
RawDescriptor: unsafe.Slice(unsafe.StringData(file_proto_agent_proto_rawDesc), len(file_proto_agent_proto_rawDesc)),
|
||||
NumEnums: 0,
|
||||
NumMessages: 3,
|
||||
NumExtensions: 0,
|
||||
NumServices: 1,
|
||||
},
|
||||
GoTypes: file_proto_agent_proto_goTypes,
|
||||
DependencyIndexes: file_proto_agent_proto_depIdxs,
|
||||
MessageInfos: file_proto_agent_proto_msgTypes,
|
||||
}.Build()
|
||||
File_proto_agent_proto = out.File
|
||||
file_proto_agent_proto_goTypes = nil
|
||||
file_proto_agent_proto_depIdxs = nil
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
// Code generated by protoc-gen-micro. DO NOT EDIT.
|
||||
// source: proto/agent.proto
|
||||
|
||||
package agent
|
||||
|
||||
import (
|
||||
fmt "fmt"
|
||||
proto "google.golang.org/protobuf/proto"
|
||||
math "math"
|
||||
)
|
||||
|
||||
import (
|
||||
context "context"
|
||||
client "go-micro.dev/v6/client"
|
||||
server "go-micro.dev/v6/server"
|
||||
)
|
||||
|
||||
// Reference imports to suppress errors if they are not otherwise used.
|
||||
var _ = proto.Marshal
|
||||
var _ = fmt.Errorf
|
||||
var _ = math.Inf
|
||||
|
||||
// Reference imports to suppress errors if they are not otherwise used.
|
||||
var _ context.Context
|
||||
var _ client.Option
|
||||
var _ server.Option
|
||||
|
||||
// Client API for Agent service
|
||||
|
||||
type AgentService interface {
|
||||
Chat(ctx context.Context, in *ChatRequest, opts ...client.CallOption) (*ChatResponse, error)
|
||||
}
|
||||
|
||||
type agentService struct {
|
||||
c client.Client
|
||||
name string
|
||||
}
|
||||
|
||||
func NewAgentService(name string, c client.Client) AgentService {
|
||||
return &agentService{
|
||||
c: c,
|
||||
name: name,
|
||||
}
|
||||
}
|
||||
|
||||
func (c *agentService) Chat(ctx context.Context, in *ChatRequest, opts ...client.CallOption) (*ChatResponse, error) {
|
||||
req := c.c.NewRequest(c.name, "Agent.Chat", in)
|
||||
out := new(ChatResponse)
|
||||
err := c.c.Call(ctx, req, out, opts...)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// Server API for Agent service
|
||||
|
||||
type AgentHandler interface {
|
||||
Chat(context.Context, *ChatRequest, *ChatResponse) error
|
||||
}
|
||||
|
||||
func RegisterAgentHandler(s server.Server, hdlr AgentHandler, opts ...server.HandlerOption) error {
|
||||
type agent interface {
|
||||
Chat(ctx context.Context, in *ChatRequest, out *ChatResponse) error
|
||||
}
|
||||
type Agent struct {
|
||||
agent
|
||||
}
|
||||
h := &agentHandler{hdlr}
|
||||
return s.Handle(s.NewHandler(&Agent{h}, opts...))
|
||||
}
|
||||
|
||||
type agentHandler struct {
|
||||
AgentHandler
|
||||
}
|
||||
|
||||
func (h *agentHandler) Chat(ctx context.Context, in *ChatRequest, out *ChatResponse) error {
|
||||
return h.AgentHandler.Chat(ctx, in, out)
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
syntax = "proto3";
|
||||
|
||||
package agent;
|
||||
|
||||
option go_package = "./proto;agent";
|
||||
|
||||
// Agent is the RPC interface for an AI agent.
|
||||
service Agent {
|
||||
rpc Chat(ChatRequest) returns (ChatResponse) {}
|
||||
}
|
||||
|
||||
message ChatRequest {
|
||||
string message = 1;
|
||||
}
|
||||
|
||||
message ChatResponse {
|
||||
string reply = 1;
|
||||
string agent = 2;
|
||||
repeated ToolCall tool_calls = 3;
|
||||
}
|
||||
|
||||
message ToolCall {
|
||||
string id = 1;
|
||||
string name = 2;
|
||||
string input = 3;
|
||||
string result = 4;
|
||||
}
|
||||
@@ -1,176 +0,0 @@
|
||||
package agent
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/store"
|
||||
)
|
||||
|
||||
// A registered wrapper runs around every tool call and can observe and
|
||||
// modify the result.
|
||||
func TestWrapToolWraps(t *testing.T) {
|
||||
var saw string
|
||||
wrap := func(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
saw = call.Name
|
||||
res := next(ctx, call)
|
||||
res.Content = "wrapped:" + res.Content
|
||||
return res
|
||||
}
|
||||
}
|
||||
|
||||
a := newTestAgent(Name("wrapped"), WrapTool(wrap))
|
||||
content := toolContent(a.toolHandler(), "demo_Svc_Do", map[string]any{})
|
||||
|
||||
if saw != "demo_Svc_Do" {
|
||||
t.Errorf("wrapper saw %q, want demo_Svc_Do", saw)
|
||||
}
|
||||
if !strings.HasPrefix(content, "wrapped:") {
|
||||
t.Errorf("wrapper did not modify the result; got %q", content)
|
||||
}
|
||||
}
|
||||
|
||||
// Multiple wrappers compose outermost-first: the first registered wrapper
|
||||
// is the outer layer, so it runs first on the way in and last on the way
|
||||
// out.
|
||||
func TestWrapToolOrder(t *testing.T) {
|
||||
var order []string
|
||||
mk := func(tag string) ai.ToolWrapper {
|
||||
return func(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
order = append(order, "in:"+tag)
|
||||
res := next(ctx, call)
|
||||
order = append(order, "out:"+tag)
|
||||
return res
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
a := newTestAgent(Name("ordered"), WrapTool(mk("a"), mk("b")))
|
||||
toolContent(a.toolHandler(), "demo_Svc_Do", map[string]any{})
|
||||
|
||||
want := "in:a in:b out:b out:a"
|
||||
if got := strings.Join(order, " "); got != want {
|
||||
t.Errorf("wrapper order = %q, want %q", got, want)
|
||||
}
|
||||
}
|
||||
|
||||
// Wrappers run outside the built-in guardrails, so they observe a refused
|
||||
// call and its refusal result rather than being short-circuited.
|
||||
func TestWrapToolSeesGuardrailRefusal(t *testing.T) {
|
||||
var sawResult string
|
||||
wrap := func(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
res := next(ctx, call)
|
||||
sawResult = res.Content
|
||||
return res
|
||||
}
|
||||
}
|
||||
|
||||
a := newTestAgent(Name("gated-wrap"),
|
||||
ApproveTool(func(tool string, input map[string]any) (bool, string) {
|
||||
return false, "denied"
|
||||
}),
|
||||
WrapTool(wrap),
|
||||
)
|
||||
toolContent(a.toolHandler(), "demo_Svc_Do", map[string]any{})
|
||||
|
||||
if !strings.Contains(sawResult, "not approved") {
|
||||
t.Errorf("wrapper should observe the guardrail refusal; got %q", sawResult)
|
||||
}
|
||||
}
|
||||
|
||||
// A guardrail refusal carries a structured reason a wrapper can switch on,
|
||||
// so reliability tooling (e.g. loop handling) needn't parse the message.
|
||||
func TestWrapToolSeesRefusedReason(t *testing.T) {
|
||||
a := newTestAgent(Name("looper"), LoopLimit(2))
|
||||
h := a.toolHandler()
|
||||
|
||||
var last ai.ToolResult
|
||||
for i := 0; i < 3; i++ {
|
||||
last = h(context.Background(), ai.ToolCall{ID: "x", Name: "demo_Svc_Do", Input: map[string]any{"q": "same"}})
|
||||
}
|
||||
if last.Refused != ai.RefusedLoop {
|
||||
t.Errorf("Refused = %q, want %q", last.Refused, ai.RefusedLoop)
|
||||
}
|
||||
}
|
||||
|
||||
// ctxMock is a model that forwards the Generate context to the tool
|
||||
// handler (as real providers do), so a wrapper can read ai.RunInfo.
|
||||
type ctxMock struct{ opts ai.Options }
|
||||
|
||||
func (m *ctxMock) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&m.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
func (m *ctxMock) Options() ai.Options { return m.opts }
|
||||
func (m *ctxMock) String() string { return "ctxmock" }
|
||||
func (m *ctxMock) Stream(context.Context, *ai.Request, ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("no stream")
|
||||
}
|
||||
func (m *ctxMock) Generate(ctx context.Context, _ *ai.Request, _ ...ai.GenerateOption) (*ai.Response, error) {
|
||||
if m.opts.ToolHandler != nil {
|
||||
m.opts.ToolHandler(ctx, ai.ToolCall{ID: "c1", Name: "demo_Svc_Do", Input: map[string]any{}})
|
||||
}
|
||||
return &ai.Response{Answer: "done"}, nil
|
||||
}
|
||||
|
||||
// During an Ask, a wrapper sees RunInfo on the context: a correlation id
|
||||
// for the run and the agent's name.
|
||||
func TestWrapToolSeesRunInfo(t *testing.T) {
|
||||
ai.Register("ctxmock", func(opts ...ai.Option) ai.Model {
|
||||
m := &ctxMock{}
|
||||
_ = m.Init(opts...)
|
||||
return m
|
||||
})
|
||||
|
||||
var got ai.RunInfo
|
||||
var ok bool
|
||||
a := New(
|
||||
Name("runner"),
|
||||
Provider("ctxmock"),
|
||||
WithRegistry(registry.NewMemoryRegistry()),
|
||||
WithStore(store.NewMemoryStore()),
|
||||
WrapTool(func(next ai.ToolHandler) ai.ToolHandler {
|
||||
return func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
got, ok = ai.RunInfoFrom(ctx)
|
||||
return next(ctx, call)
|
||||
}
|
||||
}),
|
||||
)
|
||||
|
||||
if _, err := a.Ask(context.Background(), "go"); err != nil {
|
||||
t.Fatalf("Ask: %v", err)
|
||||
}
|
||||
if !ok {
|
||||
t.Fatal("wrapper did not see RunInfo on the context")
|
||||
}
|
||||
if got.Agent != "runner" {
|
||||
t.Errorf("RunInfo.Agent = %q, want runner", got.Agent)
|
||||
}
|
||||
if got.RunID == "" {
|
||||
t.Error("RunInfo.RunID is empty")
|
||||
}
|
||||
}
|
||||
|
||||
// call.Scan decodes a tool call's input into a typed struct.
|
||||
func TestToolCallScan(t *testing.T) {
|
||||
call := ai.ToolCall{Input: map[string]any{"query": "hello", "limit": 5}}
|
||||
var args struct {
|
||||
Query string `json:"query"`
|
||||
Limit int `json:"limit"`
|
||||
}
|
||||
if err := call.Scan(&args); err != nil {
|
||||
t.Fatalf("Scan: %v", err)
|
||||
}
|
||||
if args.Query != "hello" || args.Limit != 5 {
|
||||
t.Errorf("Scan decoded %+v, want {hello 5}", args)
|
||||
}
|
||||
}
|
||||
-351
@@ -1,351 +0,0 @@
|
||||
# AI Package
|
||||
|
||||
The `ai` package provides simple, high-level interfaces for AI model providers. It supports text generation (`Model`), image generation (`ImageModel`), and video generation (`VideoModel`).
|
||||
|
||||
## Interfaces
|
||||
|
||||
### Text Generation (Model)
|
||||
|
||||
The Model interface follows the same patterns as other go-micro packages (Registry, Client, Broker):
|
||||
|
||||
```go
|
||||
type Model interface {
|
||||
Init(...Option) error
|
||||
Options() Options
|
||||
Generate(ctx context.Context, req *Request, opts ...GenerateOption) (*Response, error)
|
||||
Stream(ctx context.Context, req *Request, opts ...GenerateOption) (Stream, error)
|
||||
String() string
|
||||
}
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```go
|
||||
import (
|
||||
"context"
|
||||
"go-micro.dev/v5/ai"
|
||||
_ "go-micro.dev/v5/ai/anthropic"
|
||||
_ "go-micro.dev/v5/ai/openai"
|
||||
)
|
||||
|
||||
// Create a model
|
||||
m := ai.New("openai",
|
||||
ai.WithAPIKey("your-api-key"),
|
||||
ai.WithModel("gpt-4o"),
|
||||
)
|
||||
|
||||
// Generate a response
|
||||
req := &ai.Request{
|
||||
Prompt: "What is Go?",
|
||||
SystemPrompt: "You are a helpful programming assistant",
|
||||
}
|
||||
|
||||
resp, err := m.Generate(context.Background(), req)
|
||||
if err != nil {
|
||||
log.Fatal(err)
|
||||
}
|
||||
|
||||
fmt.Println(resp.Reply)
|
||||
```
|
||||
|
||||
### Image Generation (ImageModel)
|
||||
|
||||
```go
|
||||
type ImageModel interface {
|
||||
GenerateImage(ctx context.Context, req *ImageRequest, opts ...GenerateOption) (*ImageResponse, error)
|
||||
String() string
|
||||
}
|
||||
```
|
||||
|
||||
```go
|
||||
import (
|
||||
"go-micro.dev/v5/ai"
|
||||
_ "go-micro.dev/v5/ai/atlascloud"
|
||||
)
|
||||
|
||||
ig := ai.NewImage("atlascloud",
|
||||
ai.WithAPIKey("your-api-key"),
|
||||
)
|
||||
|
||||
resp, err := ig.GenerateImage(context.Background(), &ai.ImageRequest{
|
||||
Prompt: "A Go gopher in space",
|
||||
Size: "1024x1024",
|
||||
})
|
||||
|
||||
fmt.Println(resp.Images[0].URL)
|
||||
```
|
||||
|
||||
Providers that support image generation: **Atlas Cloud**, **OpenAI**.
|
||||
|
||||
### Video Generation (VideoModel)
|
||||
|
||||
```go
|
||||
type VideoModel interface {
|
||||
GenerateVideo(ctx context.Context, req *VideoRequest, opts ...GenerateOption) (*VideoResponse, error)
|
||||
String() string
|
||||
}
|
||||
```
|
||||
|
||||
```go
|
||||
import (
|
||||
"go-micro.dev/v5/ai"
|
||||
_ "go-micro.dev/v5/ai/atlascloud"
|
||||
)
|
||||
|
||||
vg := ai.NewVideo("atlascloud",
|
||||
ai.WithAPIKey("your-api-key"),
|
||||
)
|
||||
|
||||
resp, err := vg.GenerateVideo(context.Background(), &ai.VideoRequest{
|
||||
Prompt: "Microservices nodes animating with data flowing between them",
|
||||
Images: []string{"https://example.com/diagram.png"}, // optional: image-to-video
|
||||
Duration: 6,
|
||||
})
|
||||
|
||||
fmt.Println(resp.URL)
|
||||
```
|
||||
|
||||
Providers that support video generation: **Atlas Cloud**.
|
||||
|
||||
## Options
|
||||
|
||||
Configure the model using functional options:
|
||||
|
||||
```go
|
||||
m := ai.New("anthropic",
|
||||
ai.WithAPIKey("your-key"), // Required
|
||||
ai.WithModel("claude-sonnet-4-20250514"), // Optional, uses provider default
|
||||
ai.WithBaseURL("https://api.anthropic.com"), // Optional, uses provider default
|
||||
)
|
||||
```
|
||||
|
||||
You can also update options after creation:
|
||||
|
||||
```go
|
||||
m.Init(
|
||||
ai.WithModel("gpt-4o-mini"),
|
||||
ai.WithAPIKey("new-key"),
|
||||
)
|
||||
```
|
||||
|
||||
## Using Tools
|
||||
|
||||
The model can automatically execute tool calls when provided with a tool handler:
|
||||
|
||||
```go
|
||||
// Define a tool handler. It mirrors a go-micro RPC handler: context
|
||||
// first, the call in, a result out.
|
||||
toolHandler := func(ctx context.Context, call ai.ToolCall) ai.ToolResult {
|
||||
// Execute the tool and return results
|
||||
switch call.Name {
|
||||
case "get_weather":
|
||||
return ai.ToolResult{ID: call.ID, Value: map[string]string{"temp": "72F"}, Content: `{"temp": "72F"}`}
|
||||
default:
|
||||
return ai.ToolResult{ID: call.ID, Content: `{"error": "unknown tool"}`}
|
||||
}
|
||||
}
|
||||
|
||||
// Create model with tool handler
|
||||
m := ai.New("openai",
|
||||
ai.WithAPIKey("your-key"),
|
||||
ai.WithToolHandler(toolHandler),
|
||||
)
|
||||
|
||||
// Provide tools in the request
|
||||
req := &ai.Request{
|
||||
Prompt: "What's the weather?",
|
||||
SystemPrompt: "You are a helpful assistant",
|
||||
Tools: []ai.Tool{
|
||||
{
|
||||
Name: "get_weather",
|
||||
Description: "Get current weather",
|
||||
Properties: map[string]any{
|
||||
"location": map[string]any{
|
||||
"type": "string",
|
||||
"description": "City name",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// Generate will automatically call tools and return final answer
|
||||
resp, err := m.Generate(context.Background(), req)
|
||||
fmt.Println(resp.Answer) // Final answer after tool execution
|
||||
```
|
||||
|
||||
## Response Structure
|
||||
|
||||
```go
|
||||
type Response struct {
|
||||
Reply string // Initial reply from model
|
||||
ToolCalls []ToolCall // Tools the model wants to call
|
||||
Answer string // Final answer (after tool execution if handler provided)
|
||||
}
|
||||
```
|
||||
|
||||
- `Reply`: The model's first response
|
||||
- `ToolCalls`: List of tools the model requested (if any)
|
||||
- `Answer`: The final answer after tools are executed (only set if ToolHandler is provided)
|
||||
|
||||
## Supported Providers
|
||||
|
||||
### Anthropic Claude
|
||||
|
||||
```go
|
||||
m := ai.New("anthropic",
|
||||
ai.WithAPIKey("sk-ant-..."),
|
||||
ai.WithModel("claude-sonnet-4-20250514"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `claude-sonnet-4-20250514`
|
||||
Default base URL: `https://api.anthropic.com`
|
||||
|
||||
### OpenAI GPT
|
||||
|
||||
```go
|
||||
m := ai.New("openai",
|
||||
ai.WithAPIKey("sk-..."),
|
||||
ai.WithModel("gpt-4o"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `gpt-4o`
|
||||
Default base URL: `https://api.openai.com`
|
||||
|
||||
### Google Gemini
|
||||
|
||||
```go
|
||||
m := ai.New("gemini",
|
||||
ai.WithAPIKey("your-key"),
|
||||
ai.WithModel("gemini-2.5-flash"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `gemini-2.5-flash`
|
||||
Default base URL: `https://generativelanguage.googleapis.com`
|
||||
|
||||
Google Gemini uses its own API format with `system_instruction`, `contents` (not `messages`), and `functionDeclarations` for tool calling. The provider handles the translation automatically.
|
||||
|
||||
### Groq
|
||||
|
||||
```go
|
||||
m := ai.New("groq",
|
||||
ai.WithAPIKey("your-key"),
|
||||
ai.WithModel("llama-3.3-70b-versatile"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `llama-3.3-70b-versatile`
|
||||
Default base URL: `https://api.groq.com/openai`
|
||||
|
||||
Groq provides ultra-fast inference for open-weight models via an OpenAI-compatible endpoint.
|
||||
|
||||
### Mistral
|
||||
|
||||
```go
|
||||
m := ai.New("mistral",
|
||||
ai.WithAPIKey("your-key"),
|
||||
ai.WithModel("mistral-large-latest"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `mistral-large-latest`
|
||||
Default base URL: `https://api.mistral.ai`
|
||||
|
||||
Mistral AI is a European AI company offering high-performance models via an OpenAI-compatible endpoint.
|
||||
|
||||
### Together AI
|
||||
|
||||
```go
|
||||
m := ai.New("together",
|
||||
ai.WithAPIKey("your-key"),
|
||||
ai.WithModel("meta-llama/Llama-3.3-70B-Instruct-Turbo"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `meta-llama/Llama-3.3-70B-Instruct-Turbo`
|
||||
Default base URL: `https://api.together.xyz`
|
||||
|
||||
Together AI provides fast inference for open-weight models via an OpenAI-compatible endpoint.
|
||||
|
||||
### Atlas Cloud
|
||||
|
||||
```go
|
||||
m := ai.New("atlascloud",
|
||||
ai.WithAPIKey("your-key"),
|
||||
ai.WithModel("llama-3.3-70b"), // default
|
||||
)
|
||||
```
|
||||
|
||||
Default model: `llama-3.3-70b`
|
||||
Default base URL: `https://api.atlascloud.ai`
|
||||
|
||||
Atlas Cloud is an enterprise AI infrastructure platform offering high-performance LLM APIs. It exposes an OpenAI-compatible chat completions endpoint with tool calling support.
|
||||
|
||||
## Auto-Detection
|
||||
|
||||
Use `AutoDetectProvider()` to detect the provider from a base URL:
|
||||
|
||||
```go
|
||||
provider := ai.AutoDetectProvider("https://api.anthropic.com")
|
||||
// Returns "anthropic"
|
||||
|
||||
m := ai.New(provider, ai.WithAPIKey("..."))
|
||||
```
|
||||
|
||||
## Adding a New Provider
|
||||
|
||||
See the full **[AI Provider Integration Guide](../internal/website/docs/guides/ai-provider-guide.md)** for a step-by-step walkthrough, checklist, and design notes.
|
||||
|
||||
Quick summary:
|
||||
|
||||
1. Create `ai/yourprovider/yourprovider.go` implementing `ai.Model`.
|
||||
2. Call `ai.Register("yourprovider", ...)` in `init()`.
|
||||
3. Add tests in `ai/yourprovider/yourprovider_test.go`.
|
||||
4. Users enable the provider with a blank import:
|
||||
|
||||
```go
|
||||
import _ "go-micro.dev/v5/ai/yourprovider"
|
||||
```
|
||||
|
||||
We welcome contributions and sponsorships from AI infrastructure companies — see the guide for details.
|
||||
|
||||
## Comparison with Other Packages
|
||||
|
||||
The ai package follows the same patterns as other go-micro packages:
|
||||
|
||||
**Registry:**
|
||||
```go
|
||||
r := registry.NewRegistry(registry.Addrs("..."))
|
||||
r.Register(service)
|
||||
```
|
||||
|
||||
**Client:**
|
||||
```go
|
||||
c := client.NewClient(client.Retries(3))
|
||||
c.Call(ctx, req, rsp)
|
||||
```
|
||||
|
||||
**AI:**
|
||||
```go
|
||||
m := ai.New("openai", ai.WithAPIKey("..."))
|
||||
m.Generate(ctx, req)
|
||||
```
|
||||
|
||||
All use:
|
||||
- `Init()` to update options
|
||||
- `Options()` to get current options
|
||||
- `String()` to get the implementation name
|
||||
- Functional options pattern
|
||||
|
||||
## Testing
|
||||
|
||||
```bash
|
||||
go test ./ai/...
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
See the [server implementation](../cmd/micro/server/server.go) for a complete example of using the ai package with tool execution.
|
||||
@@ -1,272 +0,0 @@
|
||||
// Package anthropic implements the Anthropic Claude model provider
|
||||
package anthropic
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("anthropic", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
// Provider implements the ai.Model interface for Anthropic Claude
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
// NewProvider creates a new Anthropic provider
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
|
||||
// Set defaults if not provided
|
||||
if options.Model == "" {
|
||||
options.Model = "claude-sonnet-4-20250514"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://api.anthropic.com"
|
||||
}
|
||||
|
||||
return &Provider{
|
||||
opts: options,
|
||||
}
|
||||
}
|
||||
|
||||
// Init initializes the provider with options
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Options returns the provider options
|
||||
func (p *Provider) Options() ai.Options {
|
||||
return p.opts
|
||||
}
|
||||
|
||||
// String returns the provider name
|
||||
func (p *Provider) String() string {
|
||||
return "anthropic"
|
||||
}
|
||||
|
||||
// Generate generates a response from the model
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
// Build tools for Anthropic format
|
||||
var anthropicTools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
anthropicTools = append(anthropicTools, map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"input_schema": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
// Build initial request
|
||||
apiReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"max_tokens": 8192,
|
||||
"system": req.SystemPrompt,
|
||||
"messages": []map[string]any{
|
||||
{"role": "user", "content": req.Prompt},
|
||||
},
|
||||
}
|
||||
|
||||
if len(anthropicTools) > 0 {
|
||||
apiReq["tools"] = anthropicTools
|
||||
}
|
||||
|
||||
// Make API call
|
||||
resp, rawContent, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// If no tool calls or no handler, return as-is
|
||||
if len(resp.ToolCalls) == 0 || p.opts.ToolHandler == nil {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
// Tool execution loop: execute tools, send results back, repeat
|
||||
// until the model responds with text only (no more tool calls)
|
||||
messages := []map[string]any{
|
||||
{"role": "user", "content": req.Prompt},
|
||||
{"role": "assistant", "content": cleanContent(rawContent)},
|
||||
}
|
||||
|
||||
pendingCalls := resp.ToolCalls
|
||||
|
||||
for rounds := 0; rounds < 10; rounds++ {
|
||||
var toolResultBlocks []map[string]any
|
||||
for i := range pendingCalls {
|
||||
content := p.opts.ToolHandler(ctx, pendingCalls[i]).Content
|
||||
pendingCalls[i].Result = content
|
||||
toolResultBlocks = append(toolResultBlocks, map[string]any{
|
||||
"type": "tool_result",
|
||||
"tool_use_id": pendingCalls[i].ID,
|
||||
"content": content,
|
||||
})
|
||||
}
|
||||
|
||||
messages = append(messages, map[string]any{
|
||||
"role": "user",
|
||||
"content": toolResultBlocks,
|
||||
})
|
||||
|
||||
followUpReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"max_tokens": 8192,
|
||||
"system": req.SystemPrompt,
|
||||
"messages": messages,
|
||||
}
|
||||
if len(anthropicTools) > 0 {
|
||||
followUpReq["tools"] = anthropicTools
|
||||
}
|
||||
|
||||
followUpResp, followUpRaw, err := p.callAPI(ctx, followUpReq)
|
||||
if err != nil {
|
||||
break
|
||||
}
|
||||
|
||||
if len(followUpResp.ToolCalls) > 0 {
|
||||
resp.ToolCalls = append(resp.ToolCalls, followUpResp.ToolCalls...)
|
||||
pendingCalls = followUpResp.ToolCalls
|
||||
messages = append(messages, map[string]any{
|
||||
"role": "assistant",
|
||||
"content": cleanContent(followUpRaw),
|
||||
})
|
||||
continue
|
||||
}
|
||||
|
||||
if followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
// Stream generates a streaming response (not yet implemented)
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for anthropic provider")
|
||||
}
|
||||
|
||||
// callAPI makes an HTTP request to the Anthropic API
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, any, error) {
|
||||
// Marshal request
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
// Build HTTP request
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/messages"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
// Set headers
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("x-api-key", p.opts.APIKey)
|
||||
httpReq.Header.Set("anthropic-version", "2023-06-01")
|
||||
|
||||
// Make request
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
// Read response
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
// Parse response
|
||||
var anthropicResp struct {
|
||||
Content []struct {
|
||||
Type string `json:"type"`
|
||||
Text string `json:"text"`
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Input json.RawMessage `json:"input"`
|
||||
} `json:"content"`
|
||||
StopReason string `json:"stop_reason"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &anthropicResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
|
||||
response := &ai.Response{}
|
||||
|
||||
// Extract text reply
|
||||
var replyParts []string
|
||||
for _, block := range anthropicResp.Content {
|
||||
if block.Type == "text" && block.Text != "" {
|
||||
replyParts = append(replyParts, block.Text)
|
||||
}
|
||||
}
|
||||
if len(replyParts) > 0 {
|
||||
response.Reply = strings.Join(replyParts, "\n")
|
||||
}
|
||||
|
||||
// Extract tool calls
|
||||
for _, block := range anthropicResp.Content {
|
||||
if block.Type == "tool_use" {
|
||||
var input map[string]any
|
||||
if err := json.Unmarshal(block.Input, &input); err != nil {
|
||||
input = map[string]any{}
|
||||
}
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: block.ID,
|
||||
Name: block.Name,
|
||||
Input: input,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
return response, anthropicResp.Content, nil
|
||||
}
|
||||
|
||||
// cleanContent strips fields from response content blocks that Anthropic
|
||||
// rejects when sent back as assistant message content (e.g. "id" on text blocks).
|
||||
func cleanContent(raw any) any {
|
||||
blocks, ok := raw.([]struct {
|
||||
Type string `json:"type"`
|
||||
Text string `json:"text"`
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Input json.RawMessage `json:"input"`
|
||||
})
|
||||
if !ok {
|
||||
return raw
|
||||
}
|
||||
var cleaned []map[string]any
|
||||
for _, b := range blocks {
|
||||
switch b.Type {
|
||||
case "text":
|
||||
cleaned = append(cleaned, map[string]any{"type": "text", "text": b.Text})
|
||||
case "tool_use":
|
||||
var input any
|
||||
json.Unmarshal(b.Input, &input)
|
||||
cleaned = append(cleaned, map[string]any{"type": "tool_use", "id": b.ID, "name": b.Name, "input": input})
|
||||
}
|
||||
}
|
||||
return cleaned
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
package anthropic
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if p.String() != "anthropic" {
|
||||
t.Errorf("Expected provider name 'anthropic', got '%s'", p.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
err := p.Init(
|
||||
ai.WithModel("test-model"),
|
||||
ai.WithAPIKey("test-key"),
|
||||
ai.WithBaseURL("https://test.com"),
|
||||
)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("Init failed: %v", err)
|
||||
}
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "test-model" {
|
||||
t.Errorf("Expected model 'test-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "test-key" {
|
||||
t.Errorf("Expected API key 'test-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
if opts.BaseURL != "https://test.com" {
|
||||
t.Errorf("Expected base URL 'https://test.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Options(t *testing.T) {
|
||||
p := NewProvider(
|
||||
ai.WithModel("custom-model"),
|
||||
ai.WithAPIKey("my-key"),
|
||||
)
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "custom-model" {
|
||||
t.Errorf("Expected model 'custom-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "my-key" {
|
||||
t.Errorf("Expected API key 'my-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "claude-sonnet-4-20250514" {
|
||||
t.Errorf("Expected default model 'claude-sonnet-4-20250514', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://api.anthropic.com" {
|
||||
t.Errorf("Expected default base URL 'https://api.anthropic.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
SystemPrompt: "You are helpful",
|
||||
}
|
||||
|
||||
_, err := p.Generate(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
}
|
||||
|
||||
_, err := p.Stream(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error for unimplemented streaming, got nil")
|
||||
}
|
||||
}
|
||||
@@ -1,489 +0,0 @@
|
||||
// Package atlascloud implements the Atlas Cloud model provider.
|
||||
//
|
||||
// Atlas Cloud is an enterprise AI infrastructure platform offering
|
||||
// high-performance LLM, image, and video APIs. It exposes
|
||||
// OpenAI-compatible endpoints for chat completions and image
|
||||
// generation.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// import _ "go-micro.dev/v6/ai/atlascloud"
|
||||
//
|
||||
// m := ai.New("atlascloud",
|
||||
// ai.WithAPIKey("your-api-key"),
|
||||
// )
|
||||
//
|
||||
// // Image generation
|
||||
// ig := ai.NewImage("atlascloud",
|
||||
// ai.WithAPIKey("your-api-key"),
|
||||
// )
|
||||
package atlascloud
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("atlascloud", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
ai.RegisterImage("atlascloud", func(opts ...ai.Option) ai.ImageModel {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
ai.RegisterVideo("atlascloud", func(opts ...ai.Option) ai.VideoModel {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
// Provider implements the ai.Model interface for Atlas Cloud.
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
// NewProvider creates a new Atlas Cloud provider.
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
|
||||
if options.Model == "" {
|
||||
options.Model = "deepseek-ai/DeepSeek-V3-0324"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://api.atlascloud.ai"
|
||||
}
|
||||
|
||||
return &Provider{opts: options}
|
||||
}
|
||||
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Provider) Options() ai.Options { return p.opts }
|
||||
func (p *Provider) String() string { return "atlascloud" }
|
||||
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
var tools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
tools = append(tools, map[string]any{
|
||||
"type": "function",
|
||||
"function": map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"parameters": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
messages := []map[string]any{
|
||||
{"role": "system", "content": req.SystemPrompt},
|
||||
{"role": "user", "content": req.Prompt},
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": messages,
|
||||
}
|
||||
|
||||
if len(tools) > 0 {
|
||||
apiReq["tools"] = tools
|
||||
}
|
||||
|
||||
resp, rawMessage, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if len(resp.ToolCalls) == 0 {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
if p.opts.ToolHandler != nil {
|
||||
followUpMessages := append(messages, map[string]any{
|
||||
"role": "assistant",
|
||||
"content": rawMessage["content"],
|
||||
"tool_calls": rawMessage["tool_calls"],
|
||||
})
|
||||
|
||||
for _, tc := range resp.ToolCalls {
|
||||
content := p.opts.ToolHandler(ctx, tc).Content
|
||||
followUpMessages = append(followUpMessages, map[string]any{
|
||||
"role": "tool",
|
||||
"tool_call_id": tc.ID,
|
||||
"content": content,
|
||||
})
|
||||
}
|
||||
|
||||
followUpReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": followUpMessages,
|
||||
}
|
||||
|
||||
followUpResp, _, err := p.callAPI(ctx, followUpReq)
|
||||
if err == nil && followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for atlascloud provider")
|
||||
}
|
||||
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, map[string]any, error) {
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/chat/completions"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var chatResp struct {
|
||||
Choices []struct {
|
||||
Message struct {
|
||||
Content string `json:"content"`
|
||||
ToolCalls []struct {
|
||||
ID string `json:"id"`
|
||||
Function struct {
|
||||
Name string `json:"name"`
|
||||
Arguments string `json:"arguments"`
|
||||
} `json:"function"`
|
||||
} `json:"tool_calls"`
|
||||
} `json:"message"`
|
||||
} `json:"choices"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &chatResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
|
||||
if len(chatResp.Choices) == 0 {
|
||||
return nil, nil, fmt.Errorf("no response from API")
|
||||
}
|
||||
|
||||
choice := chatResp.Choices[0]
|
||||
response := &ai.Response{
|
||||
Reply: choice.Message.Content,
|
||||
}
|
||||
|
||||
for _, tc := range choice.Message.ToolCalls {
|
||||
var input map[string]any
|
||||
if err := json.Unmarshal([]byte(tc.Function.Arguments), &input); err != nil {
|
||||
input = map[string]any{}
|
||||
}
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: tc.ID,
|
||||
Name: tc.Function.Name,
|
||||
Input: input,
|
||||
})
|
||||
}
|
||||
|
||||
rawMessage := map[string]any{
|
||||
"content": choice.Message.Content,
|
||||
"tool_calls": choice.Message.ToolCalls,
|
||||
}
|
||||
|
||||
return response, rawMessage, nil
|
||||
}
|
||||
|
||||
const defaultImageModel = "openai/gpt-image-2/text-to-image"
|
||||
|
||||
// GenerateImage creates an image using Atlas Cloud's async image API.
|
||||
// It submits the job and polls until completion or context cancellation.
|
||||
func (p *Provider) GenerateImage(ctx context.Context, req *ai.ImageRequest, opts ...ai.GenerateOption) (*ai.ImageResponse, error) {
|
||||
model := req.Model
|
||||
if model == "" {
|
||||
model = defaultImageModel
|
||||
}
|
||||
quality := req.Quality
|
||||
if quality == "" {
|
||||
quality = "medium"
|
||||
}
|
||||
outputFmt := req.OutputFormat
|
||||
if outputFmt == "" {
|
||||
outputFmt = "png"
|
||||
}
|
||||
size := req.Size
|
||||
if size == "" {
|
||||
size = "1024x1024"
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": model,
|
||||
"prompt": req.Prompt,
|
||||
"quality": quality,
|
||||
"output_format": outputFmt,
|
||||
"size": size,
|
||||
"enable_sync_mode": false,
|
||||
"enable_base64_output": false,
|
||||
"moderation": "low",
|
||||
}
|
||||
|
||||
reqBody, err := json.Marshal(apiReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/api/v1/model/generateImage"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var submitResp struct {
|
||||
Code int `json:"code"`
|
||||
Msg string `json:"message"`
|
||||
Data struct {
|
||||
ID string `json:"id"`
|
||||
Status string `json:"status"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(respBody, &submitResp); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse submit response: %w", err)
|
||||
}
|
||||
if submitResp.Code != 200 {
|
||||
return nil, fmt.Errorf("API error: %s", submitResp.Msg)
|
||||
}
|
||||
|
||||
predictionID := submitResp.Data.ID
|
||||
pollURL := strings.TrimRight(p.opts.BaseURL, "/") + "/api/v1/model/prediction/" + predictionID
|
||||
|
||||
ticker := time.NewTicker(2 * time.Second)
|
||||
defer ticker.Stop()
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return nil, ctx.Err()
|
||||
case <-ticker.C:
|
||||
result, err := p.pollPrediction(ctx, pollURL)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if result != nil {
|
||||
return result, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (p *Provider) pollPrediction(ctx context.Context, url string) (*ai.ImageResponse, error) {
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("poll request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
body, _ := io.ReadAll(httpResp.Body)
|
||||
|
||||
var pollResp struct {
|
||||
Data struct {
|
||||
Status string `json:"status"`
|
||||
Outputs []string `json:"outputs"`
|
||||
Error string `json:"error"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(body, &pollResp); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse poll response: %w", err)
|
||||
}
|
||||
|
||||
switch pollResp.Data.Status {
|
||||
case "completed":
|
||||
resp := &ai.ImageResponse{}
|
||||
for _, output := range pollResp.Data.Outputs {
|
||||
resp.Images = append(resp.Images, ai.Image{URL: output})
|
||||
}
|
||||
return resp, nil
|
||||
case "failed":
|
||||
return nil, fmt.Errorf("image generation failed: %s", pollResp.Data.Error)
|
||||
default:
|
||||
return nil, nil
|
||||
}
|
||||
}
|
||||
|
||||
const defaultVideoModel = "google/gemini-omni-flash/image-to-video-developer"
|
||||
|
||||
// GenerateVideo creates a video using Atlas Cloud's async video API.
|
||||
// Supports text-to-video and image-to-video depending on whether
|
||||
// Images are provided in the request.
|
||||
func (p *Provider) GenerateVideo(ctx context.Context, req *ai.VideoRequest, opts ...ai.GenerateOption) (*ai.VideoResponse, error) {
|
||||
model := req.Model
|
||||
if model == "" {
|
||||
model = defaultVideoModel
|
||||
}
|
||||
duration := req.Duration
|
||||
if duration <= 0 {
|
||||
duration = 6
|
||||
}
|
||||
aspect := req.AspectRatio
|
||||
if aspect == "" {
|
||||
aspect = "16:9"
|
||||
}
|
||||
resolution := req.Resolution
|
||||
if resolution == "" {
|
||||
resolution = "720p"
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": model,
|
||||
"prompt": req.Prompt,
|
||||
"duration": duration,
|
||||
"aspect_ratio": aspect,
|
||||
"resolution": resolution,
|
||||
"seed": -1,
|
||||
}
|
||||
if len(req.Images) > 0 {
|
||||
apiReq["images"] = req.Images
|
||||
}
|
||||
|
||||
reqBody, err := json.Marshal(apiReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/api/v1/model/generateVideo"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var submitResp struct {
|
||||
Code int `json:"code"`
|
||||
Msg string `json:"message"`
|
||||
Data struct {
|
||||
ID string `json:"id"`
|
||||
Status string `json:"status"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(respBody, &submitResp); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse submit response: %w", err)
|
||||
}
|
||||
if submitResp.Code != 200 {
|
||||
return nil, fmt.Errorf("API error: %s", submitResp.Msg)
|
||||
}
|
||||
|
||||
pollURL := strings.TrimRight(p.opts.BaseURL, "/") + "/api/v1/model/prediction/" + submitResp.Data.ID
|
||||
|
||||
ticker := time.NewTicker(5 * time.Second)
|
||||
defer ticker.Stop()
|
||||
|
||||
for {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return nil, ctx.Err()
|
||||
case <-ticker.C:
|
||||
result, err := p.pollVideo(ctx, pollURL)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if result != nil {
|
||||
return result, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (p *Provider) pollVideo(ctx context.Context, url string) (*ai.VideoResponse, error) {
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "GET", url, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("poll request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
body, _ := io.ReadAll(httpResp.Body)
|
||||
|
||||
var pollResp struct {
|
||||
Data struct {
|
||||
Status string `json:"status"`
|
||||
Outputs []string `json:"outputs"`
|
||||
Error string `json:"error"`
|
||||
} `json:"data"`
|
||||
}
|
||||
if err := json.Unmarshal(body, &pollResp); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse poll response: %w", err)
|
||||
}
|
||||
|
||||
switch pollResp.Data.Status {
|
||||
case "completed", "succeeded":
|
||||
if len(pollResp.Data.Outputs) == 0 {
|
||||
return nil, fmt.Errorf("video completed but no outputs returned")
|
||||
}
|
||||
return &ai.VideoResponse{URL: pollResp.Data.Outputs[0]}, nil
|
||||
case "failed":
|
||||
return nil, fmt.Errorf("video generation failed: %s", pollResp.Data.Error)
|
||||
default:
|
||||
return nil, nil
|
||||
}
|
||||
}
|
||||
@@ -1,148 +0,0 @@
|
||||
package atlascloud
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if p.String() != "atlascloud" {
|
||||
t.Errorf("Expected provider name 'atlascloud', got '%s'", p.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
err := p.Init(
|
||||
ai.WithModel("test-model"),
|
||||
ai.WithAPIKey("test-key"),
|
||||
ai.WithBaseURL("https://test.com"),
|
||||
)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("Init failed: %v", err)
|
||||
}
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "test-model" {
|
||||
t.Errorf("Expected model 'test-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "test-key" {
|
||||
t.Errorf("Expected API key 'test-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
if opts.BaseURL != "https://test.com" {
|
||||
t.Errorf("Expected base URL 'https://test.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Options(t *testing.T) {
|
||||
p := NewProvider(
|
||||
ai.WithModel("custom-model"),
|
||||
ai.WithAPIKey("my-key"),
|
||||
)
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "custom-model" {
|
||||
t.Errorf("Expected model 'custom-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "my-key" {
|
||||
t.Errorf("Expected API key 'my-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "deepseek-ai/DeepSeek-V3-0324" {
|
||||
t.Errorf("Expected default model 'deepseek-ai/DeepSeek-V3-0324', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://api.atlascloud.ai" {
|
||||
t.Errorf("Expected default base URL 'https://api.atlascloud.ai', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
SystemPrompt: "You are helpful",
|
||||
}
|
||||
|
||||
_, err := p.Generate(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
}
|
||||
|
||||
_, err := p.Stream(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error for unimplemented streaming, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Registration(t *testing.T) {
|
||||
m := ai.New("atlascloud", ai.WithAPIKey("test"))
|
||||
if m == nil {
|
||||
t.Fatal("ai.New('atlascloud') returned nil — provider not registered")
|
||||
}
|
||||
if m.String() != "atlascloud" {
|
||||
t.Errorf("Expected 'atlascloud', got '%s'", m.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_ImageRegistration(t *testing.T) {
|
||||
ig := ai.NewImage("atlascloud", ai.WithAPIKey("test"))
|
||||
if ig == nil {
|
||||
t.Fatal("ai.NewImage('atlascloud') returned nil — image provider not registered")
|
||||
}
|
||||
if ig.String() != "atlascloud" {
|
||||
t.Errorf("Expected 'atlascloud', got '%s'", ig.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_GenerateImage_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
_, err := p.GenerateImage(context.Background(), &ai.ImageRequest{Prompt: "a cat"})
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_ImplementsImageModel(t *testing.T) {
|
||||
var _ ai.ImageModel = (*Provider)(nil)
|
||||
}
|
||||
|
||||
func TestProvider_VideoRegistration(t *testing.T) {
|
||||
vg := ai.NewVideo("atlascloud", ai.WithAPIKey("test"))
|
||||
if vg == nil {
|
||||
t.Fatal("ai.NewVideo('atlascloud') returned nil — video provider not registered")
|
||||
}
|
||||
if vg.String() != "atlascloud" {
|
||||
t.Errorf("Expected 'atlascloud', got '%s'", vg.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_GenerateVideo_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
_, err := p.GenerateVideo(context.Background(), &ai.VideoRequest{Prompt: "a cat"})
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_ImplementsVideoModel(t *testing.T) {
|
||||
var _ ai.VideoModel = (*Provider)(nil)
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
// Package flow is maintained for backward compatibility.
|
||||
// The canonical import is go-micro.dev/v6/flow.
|
||||
package flow
|
||||
|
||||
import "go-micro.dev/v6/flow"
|
||||
|
||||
// Re-export types for backward compatibility.
|
||||
type Flow = flow.Flow
|
||||
type Options = flow.Options
|
||||
type Option = flow.Option
|
||||
type Result = flow.Result
|
||||
|
||||
var New = flow.New
|
||||
var Trigger = flow.Trigger
|
||||
var Prompt = flow.Prompt
|
||||
var SystemPrompt = flow.SystemPrompt
|
||||
var Provider = flow.Provider
|
||||
var APIKey = flow.APIKey
|
||||
var Model = flow.Model
|
||||
var BaseURL = flow.BaseURL
|
||||
var HistoryLimit = flow.HistoryLimit
|
||||
var OnResult = flow.OnResult
|
||||
@@ -1,226 +0,0 @@
|
||||
// Package gemini implements the Google Gemini model provider.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// import _ "go-micro.dev/v6/ai/gemini"
|
||||
//
|
||||
// m := ai.New("gemini",
|
||||
// ai.WithAPIKey("your-api-key"),
|
||||
// )
|
||||
package gemini
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("gemini", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
// Provider implements the ai.Model interface for Google Gemini.
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
// NewProvider creates a new Gemini provider.
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
|
||||
if options.Model == "" {
|
||||
options.Model = "gemini-2.5-flash"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://generativelanguage.googleapis.com"
|
||||
}
|
||||
|
||||
return &Provider{opts: options}
|
||||
}
|
||||
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Provider) Options() ai.Options { return p.opts }
|
||||
func (p *Provider) String() string { return "gemini" }
|
||||
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
var tools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
tools = append(tools, map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"parameters": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
contents := []map[string]any{
|
||||
{"role": "user", "parts": []map[string]any{{"text": req.Prompt}}},
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"contents": contents,
|
||||
}
|
||||
|
||||
if req.SystemPrompt != "" {
|
||||
apiReq["system_instruction"] = map[string]any{
|
||||
"parts": []map[string]any{{"text": req.SystemPrompt}},
|
||||
}
|
||||
}
|
||||
|
||||
if len(tools) > 0 {
|
||||
apiReq["tools"] = []map[string]any{
|
||||
{"functionDeclarations": tools},
|
||||
}
|
||||
}
|
||||
|
||||
resp, rawParts, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if len(resp.ToolCalls) == 0 {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
if p.opts.ToolHandler != nil {
|
||||
var resultParts []map[string]any
|
||||
for _, tc := range resp.ToolCalls {
|
||||
result := p.opts.ToolHandler(ctx, tc).Value
|
||||
resultParts = append(resultParts, map[string]any{
|
||||
"functionResponse": map[string]any{
|
||||
"name": tc.Name,
|
||||
"id": tc.ID,
|
||||
"response": result,
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
followUpContents := append(contents,
|
||||
map[string]any{"role": "model", "parts": rawParts},
|
||||
map[string]any{"role": "user", "parts": resultParts},
|
||||
)
|
||||
|
||||
followUpReq := map[string]any{
|
||||
"contents": followUpContents,
|
||||
}
|
||||
if req.SystemPrompt != "" {
|
||||
followUpReq["system_instruction"] = map[string]any{
|
||||
"parts": []map[string]any{{"text": req.SystemPrompt}},
|
||||
}
|
||||
}
|
||||
|
||||
followUpResp, _, err := p.callAPI(ctx, followUpReq)
|
||||
if err == nil && followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for gemini provider")
|
||||
}
|
||||
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, []map[string]any, error) {
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") +
|
||||
"/v1beta/models/" + p.opts.Model + ":generateContent"
|
||||
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("x-goog-api-key", p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var geminiResp struct {
|
||||
Candidates []struct {
|
||||
Content struct {
|
||||
Parts []struct {
|
||||
Text string `json:"text"`
|
||||
FunctionCall *functionCallPB `json:"functionCall"`
|
||||
} `json:"parts"`
|
||||
} `json:"content"`
|
||||
} `json:"candidates"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &geminiResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
|
||||
if len(geminiResp.Candidates) == 0 {
|
||||
return nil, nil, fmt.Errorf("no response from API")
|
||||
}
|
||||
|
||||
parts := geminiResp.Candidates[0].Content.Parts
|
||||
response := &ai.Response{}
|
||||
|
||||
var replyParts []string
|
||||
var rawParts []map[string]any
|
||||
|
||||
for _, part := range parts {
|
||||
if part.Text != "" {
|
||||
replyParts = append(replyParts, part.Text)
|
||||
rawParts = append(rawParts, map[string]any{"text": part.Text})
|
||||
}
|
||||
if part.FunctionCall != nil {
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: part.FunctionCall.ID,
|
||||
Name: part.FunctionCall.Name,
|
||||
Input: part.FunctionCall.Args,
|
||||
})
|
||||
rawParts = append(rawParts, map[string]any{
|
||||
"functionCall": map[string]any{
|
||||
"id": part.FunctionCall.ID,
|
||||
"name": part.FunctionCall.Name,
|
||||
"args": part.FunctionCall.Args,
|
||||
},
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
if len(replyParts) > 0 {
|
||||
response.Reply = strings.Join(replyParts, "\n")
|
||||
}
|
||||
|
||||
return response, rawParts, nil
|
||||
}
|
||||
|
||||
type functionCallPB struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Args map[string]any `json:"args"`
|
||||
}
|
||||
@@ -1,104 +0,0 @@
|
||||
package gemini
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if p.String() != "gemini" {
|
||||
t.Errorf("Expected provider name 'gemini', got '%s'", p.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
err := p.Init(
|
||||
ai.WithModel("gemini-2.0-flash"),
|
||||
ai.WithAPIKey("test-key"),
|
||||
ai.WithBaseURL("https://test.com"),
|
||||
)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("Init failed: %v", err)
|
||||
}
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "gemini-2.0-flash" {
|
||||
t.Errorf("Expected model 'gemini-2.0-flash', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "test-key" {
|
||||
t.Errorf("Expected API key 'test-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
if opts.BaseURL != "https://test.com" {
|
||||
t.Errorf("Expected base URL 'https://test.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Options(t *testing.T) {
|
||||
p := NewProvider(
|
||||
ai.WithModel("custom-model"),
|
||||
ai.WithAPIKey("my-key"),
|
||||
)
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "custom-model" {
|
||||
t.Errorf("Expected model 'custom-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "my-key" {
|
||||
t.Errorf("Expected API key 'my-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "gemini-2.5-flash" {
|
||||
t.Errorf("Expected default model 'gemini-2.5-flash', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://generativelanguage.googleapis.com" {
|
||||
t.Errorf("Expected default base URL 'https://generativelanguage.googleapis.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
SystemPrompt: "You are helpful",
|
||||
}
|
||||
|
||||
_, err := p.Generate(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
}
|
||||
|
||||
_, err := p.Stream(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error for unimplemented streaming, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Registration(t *testing.T) {
|
||||
m := ai.New("gemini", ai.WithAPIKey("test"))
|
||||
if m == nil {
|
||||
t.Fatal("ai.New('gemini') returned nil — provider not registered")
|
||||
}
|
||||
if m.String() != "gemini" {
|
||||
t.Errorf("Expected 'gemini', got '%s'", m.String())
|
||||
}
|
||||
}
|
||||
-194
@@ -1,194 +0,0 @@
|
||||
// Package groq implements the Groq model provider.
|
||||
//
|
||||
// Groq provides ultra-fast inference for open-weight models via an
|
||||
// OpenAI-compatible chat completions endpoint.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// import _ "go-micro.dev/v6/ai/groq"
|
||||
//
|
||||
// m := ai.New("groq",
|
||||
// ai.WithAPIKey("your-api-key"),
|
||||
// )
|
||||
package groq
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("groq", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
if options.Model == "" {
|
||||
options.Model = "llama-3.3-70b-versatile"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://api.groq.com/openai"
|
||||
}
|
||||
return &Provider{opts: options}
|
||||
}
|
||||
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Provider) Options() ai.Options { return p.opts }
|
||||
func (p *Provider) String() string { return "groq" }
|
||||
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
var tools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
tools = append(tools, map[string]any{
|
||||
"type": "function",
|
||||
"function": map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"parameters": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
messages := []map[string]any{
|
||||
{"role": "system", "content": req.SystemPrompt},
|
||||
{"role": "user", "content": req.Prompt},
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": messages,
|
||||
}
|
||||
if len(tools) > 0 {
|
||||
apiReq["tools"] = tools
|
||||
}
|
||||
|
||||
resp, rawMessage, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(resp.ToolCalls) == 0 {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
if p.opts.ToolHandler != nil {
|
||||
followUpMessages := append(messages, map[string]any{
|
||||
"role": "assistant",
|
||||
"content": rawMessage["content"],
|
||||
"tool_calls": rawMessage["tool_calls"],
|
||||
})
|
||||
for _, tc := range resp.ToolCalls {
|
||||
content := p.opts.ToolHandler(ctx, tc).Content
|
||||
followUpMessages = append(followUpMessages, map[string]any{
|
||||
"role": "tool",
|
||||
"tool_call_id": tc.ID,
|
||||
"content": content,
|
||||
})
|
||||
}
|
||||
followUpResp, _, err := p.callAPI(ctx, map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": followUpMessages,
|
||||
})
|
||||
if err == nil && followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for groq provider")
|
||||
}
|
||||
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, map[string]any, error) {
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/chat/completions"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var chatResp struct {
|
||||
Choices []struct {
|
||||
Message struct {
|
||||
Content string `json:"content"`
|
||||
ToolCalls []struct {
|
||||
ID string `json:"id"`
|
||||
Function struct {
|
||||
Name string `json:"name"`
|
||||
Arguments string `json:"arguments"`
|
||||
} `json:"function"`
|
||||
} `json:"tool_calls"`
|
||||
} `json:"message"`
|
||||
} `json:"choices"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &chatResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
if len(chatResp.Choices) == 0 {
|
||||
return nil, nil, fmt.Errorf("no response from API")
|
||||
}
|
||||
|
||||
choice := chatResp.Choices[0]
|
||||
response := &ai.Response{Reply: choice.Message.Content}
|
||||
|
||||
for _, tc := range choice.Message.ToolCalls {
|
||||
var input map[string]any
|
||||
if err := json.Unmarshal([]byte(tc.Function.Arguments), &input); err != nil {
|
||||
input = map[string]any{}
|
||||
}
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: tc.ID,
|
||||
Name: tc.Function.Name,
|
||||
Input: input,
|
||||
})
|
||||
}
|
||||
|
||||
rawMessage := map[string]any{
|
||||
"content": choice.Message.Content,
|
||||
"tool_calls": choice.Message.ToolCalls,
|
||||
}
|
||||
|
||||
return response, rawMessage, nil
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
package groq
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
if NewProvider().String() != "groq" {
|
||||
t.Errorf("got %q", NewProvider().String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
opts := NewProvider().Options()
|
||||
if opts.Model != "llama-3.3-70b-versatile" {
|
||||
t.Errorf("default model = %q", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://api.groq.com/openai" {
|
||||
t.Errorf("default base URL = %q", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if err := p.Init(ai.WithModel("m"), ai.WithAPIKey("k")); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if p.Options().Model != "m" || p.Options().APIKey != "k" {
|
||||
t.Error("Init did not apply options")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
if _, err := NewProvider().Generate(context.Background(), &ai.Request{Prompt: "hi"}); err == nil {
|
||||
t.Error("expected error without API key")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
if _, err := NewProvider().Stream(context.Background(), &ai.Request{Prompt: "hi"}); err == nil {
|
||||
t.Error("expected error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Registration(t *testing.T) {
|
||||
m := ai.New("groq", ai.WithAPIKey("test"))
|
||||
if m == nil {
|
||||
t.Fatal("provider not registered")
|
||||
}
|
||||
if m.String() != "groq" {
|
||||
t.Errorf("got %q", m.String())
|
||||
}
|
||||
}
|
||||
@@ -1,45 +0,0 @@
|
||||
package ai
|
||||
|
||||
// History is a convenience for accumulating conversation messages
|
||||
// with automatic truncation. Use it to build Request.Messages for
|
||||
// multi-turn conversations.
|
||||
//
|
||||
// hist := ai.NewHistory(50)
|
||||
// hist.Add("user", "hello")
|
||||
// resp, _ := m.Generate(ctx, &ai.Request{Messages: hist.Messages(), Prompt: "next"})
|
||||
// hist.Add("assistant", resp.Reply)
|
||||
type History struct {
|
||||
messages []Message
|
||||
limit int
|
||||
}
|
||||
|
||||
// NewHistory creates an empty History. limit controls the maximum
|
||||
// number of messages retained (0 = unlimited).
|
||||
func NewHistory(limit int) *History {
|
||||
return &History{limit: limit}
|
||||
}
|
||||
|
||||
// Add appends a message and truncates if over limit.
|
||||
func (h *History) Add(role string, content any) {
|
||||
h.messages = append(h.messages, Message{Role: role, Content: content})
|
||||
if h.limit > 0 && len(h.messages) > h.limit {
|
||||
h.messages = h.messages[len(h.messages)-h.limit:]
|
||||
}
|
||||
}
|
||||
|
||||
// Messages returns a copy of the accumulated messages.
|
||||
func (h *History) Messages() []Message {
|
||||
out := make([]Message, len(h.messages))
|
||||
copy(out, h.messages)
|
||||
return out
|
||||
}
|
||||
|
||||
// Len returns the number of messages.
|
||||
func (h *History) Len() int {
|
||||
return len(h.messages)
|
||||
}
|
||||
|
||||
// Reset clears all messages.
|
||||
func (h *History) Reset() {
|
||||
h.messages = nil
|
||||
}
|
||||
@@ -1,62 +0,0 @@
|
||||
package ai
|
||||
|
||||
import "testing"
|
||||
|
||||
func TestHistory_Add(t *testing.T) {
|
||||
h := NewHistory(0)
|
||||
h.Add("user", "hello")
|
||||
h.Add("assistant", "hi")
|
||||
|
||||
if h.Len() != 2 {
|
||||
t.Errorf("len = %d, want 2", h.Len())
|
||||
}
|
||||
msgs := h.Messages()
|
||||
if msgs[0].Role != "user" || msgs[0].Content != "hello" {
|
||||
t.Errorf("first = %+v", msgs[0])
|
||||
}
|
||||
if msgs[1].Role != "assistant" || msgs[1].Content != "hi" {
|
||||
t.Errorf("second = %+v", msgs[1])
|
||||
}
|
||||
}
|
||||
|
||||
func TestHistory_Truncation(t *testing.T) {
|
||||
h := NewHistory(3)
|
||||
for _, m := range []string{"a", "b", "c", "d", "e"} {
|
||||
h.Add("user", m)
|
||||
}
|
||||
if h.Len() != 3 {
|
||||
t.Errorf("len = %d, want 3", h.Len())
|
||||
}
|
||||
if h.Messages()[0].Content != "c" {
|
||||
t.Errorf("first retained = %+v", h.Messages()[0])
|
||||
}
|
||||
}
|
||||
|
||||
func TestHistory_Reset(t *testing.T) {
|
||||
h := NewHistory(0)
|
||||
h.Add("user", "hello")
|
||||
h.Reset()
|
||||
if h.Len() != 0 {
|
||||
t.Errorf("len after reset = %d", h.Len())
|
||||
}
|
||||
}
|
||||
|
||||
func TestHistory_SnapshotIsCopy(t *testing.T) {
|
||||
h := NewHistory(0)
|
||||
h.Add("user", "hello")
|
||||
msgs := h.Messages()
|
||||
msgs[0].Content = "mutated"
|
||||
if h.Messages()[0].Content == "mutated" {
|
||||
t.Error("snapshot returned reference, not copy")
|
||||
}
|
||||
}
|
||||
|
||||
func TestHistory_Unlimited(t *testing.T) {
|
||||
h := NewHistory(0)
|
||||
for i := 0; i < 100; i++ {
|
||||
h.Add("user", "msg")
|
||||
}
|
||||
if h.Len() != 100 {
|
||||
t.Errorf("len = %d, want 100", h.Len())
|
||||
}
|
||||
}
|
||||
-65
@@ -1,65 +0,0 @@
|
||||
package ai
|
||||
|
||||
import "context"
|
||||
|
||||
// ImageModel provides an interface for image generation providers.
|
||||
// Providers that support image generation implement this alongside
|
||||
// or instead of Model. Use NewImage to construct, or type-assert
|
||||
// a provider that implements both:
|
||||
//
|
||||
// p := atlascloud.NewProvider(ai.WithAPIKey(key))
|
||||
// if ig, ok := p.(ai.ImageModel); ok {
|
||||
// resp, _ := ig.GenerateImage(ctx, req)
|
||||
// }
|
||||
type ImageModel interface {
|
||||
GenerateImage(ctx context.Context, req *ImageRequest, opts ...GenerateOption) (*ImageResponse, error)
|
||||
String() string
|
||||
}
|
||||
|
||||
// ImageRequest describes what image to generate.
|
||||
type ImageRequest struct {
|
||||
// Prompt is the text description of the image to generate.
|
||||
Prompt string
|
||||
// Model overrides the provider's default image model.
|
||||
Model string
|
||||
// Size of the generated image (e.g. "1024x1024"). Provider-specific.
|
||||
Size string
|
||||
// N is the number of images to generate. Defaults to 1.
|
||||
N int
|
||||
// Quality controls generation quality. Provider-specific (e.g. "low", "medium", "high").
|
||||
Quality string
|
||||
// OutputFormat sets the image format (e.g. "png", "jpeg"). Provider-specific.
|
||||
OutputFormat string
|
||||
}
|
||||
|
||||
// ImageResponse holds the generated images.
|
||||
type ImageResponse struct {
|
||||
Images []Image
|
||||
}
|
||||
|
||||
// Image is a single generated image, returned as a URL, base64 data, or both
|
||||
// depending on the provider and request options.
|
||||
type Image struct {
|
||||
// URL is a remote URL where the image can be fetched.
|
||||
URL string
|
||||
// Base64 is the base64-encoded image data.
|
||||
Base64 string
|
||||
}
|
||||
|
||||
// NewImageFunc creates a new ImageModel instance.
|
||||
type NewImageFunc func(...Option) ImageModel
|
||||
|
||||
var imageProviders = make(map[string]NewImageFunc)
|
||||
|
||||
// RegisterImage registers an image generation provider.
|
||||
func RegisterImage(name string, fn NewImageFunc) {
|
||||
imageProviders[name] = fn
|
||||
}
|
||||
|
||||
// NewImage creates a new ImageModel instance based on the provider name.
|
||||
func NewImage(provider string, opts ...Option) ImageModel {
|
||||
if fn, ok := imageProviders[provider]; ok {
|
||||
return fn(opts...)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -1,194 +0,0 @@
|
||||
// Package mistral implements the Mistral AI model provider.
|
||||
//
|
||||
// Mistral AI is a European AI company offering high-performance models
|
||||
// via an OpenAI-compatible chat completions endpoint.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// import _ "go-micro.dev/v6/ai/mistral"
|
||||
//
|
||||
// m := ai.New("mistral",
|
||||
// ai.WithAPIKey("your-api-key"),
|
||||
// )
|
||||
package mistral
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("mistral", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
if options.Model == "" {
|
||||
options.Model = "mistral-large-latest"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://api.mistral.ai"
|
||||
}
|
||||
return &Provider{opts: options}
|
||||
}
|
||||
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Provider) Options() ai.Options { return p.opts }
|
||||
func (p *Provider) String() string { return "mistral" }
|
||||
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
var tools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
tools = append(tools, map[string]any{
|
||||
"type": "function",
|
||||
"function": map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"parameters": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
messages := []map[string]any{
|
||||
{"role": "system", "content": req.SystemPrompt},
|
||||
{"role": "user", "content": req.Prompt},
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": messages,
|
||||
}
|
||||
if len(tools) > 0 {
|
||||
apiReq["tools"] = tools
|
||||
}
|
||||
|
||||
resp, rawMessage, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(resp.ToolCalls) == 0 {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
if p.opts.ToolHandler != nil {
|
||||
followUpMessages := append(messages, map[string]any{
|
||||
"role": "assistant",
|
||||
"content": rawMessage["content"],
|
||||
"tool_calls": rawMessage["tool_calls"],
|
||||
})
|
||||
for _, tc := range resp.ToolCalls {
|
||||
content := p.opts.ToolHandler(ctx, tc).Content
|
||||
followUpMessages = append(followUpMessages, map[string]any{
|
||||
"role": "tool",
|
||||
"tool_call_id": tc.ID,
|
||||
"content": content,
|
||||
})
|
||||
}
|
||||
followUpResp, _, err := p.callAPI(ctx, map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": followUpMessages,
|
||||
})
|
||||
if err == nil && followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for mistral provider")
|
||||
}
|
||||
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, map[string]any, error) {
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/chat/completions"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var chatResp struct {
|
||||
Choices []struct {
|
||||
Message struct {
|
||||
Content string `json:"content"`
|
||||
ToolCalls []struct {
|
||||
ID string `json:"id"`
|
||||
Function struct {
|
||||
Name string `json:"name"`
|
||||
Arguments string `json:"arguments"`
|
||||
} `json:"function"`
|
||||
} `json:"tool_calls"`
|
||||
} `json:"message"`
|
||||
} `json:"choices"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &chatResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
if len(chatResp.Choices) == 0 {
|
||||
return nil, nil, fmt.Errorf("no response from API")
|
||||
}
|
||||
|
||||
choice := chatResp.Choices[0]
|
||||
response := &ai.Response{Reply: choice.Message.Content}
|
||||
|
||||
for _, tc := range choice.Message.ToolCalls {
|
||||
var input map[string]any
|
||||
if err := json.Unmarshal([]byte(tc.Function.Arguments), &input); err != nil {
|
||||
input = map[string]any{}
|
||||
}
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: tc.ID,
|
||||
Name: tc.Function.Name,
|
||||
Input: input,
|
||||
})
|
||||
}
|
||||
|
||||
rawMessage := map[string]any{
|
||||
"content": choice.Message.Content,
|
||||
"tool_calls": choice.Message.ToolCalls,
|
||||
}
|
||||
|
||||
return response, rawMessage, nil
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
package mistral
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
if NewProvider().String() != "mistral" {
|
||||
t.Errorf("got %q", NewProvider().String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
opts := NewProvider().Options()
|
||||
if opts.Model != "mistral-large-latest" {
|
||||
t.Errorf("default model = %q", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://api.mistral.ai" {
|
||||
t.Errorf("default base URL = %q", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if err := p.Init(ai.WithModel("m"), ai.WithAPIKey("k")); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if p.Options().Model != "m" || p.Options().APIKey != "k" {
|
||||
t.Error("Init did not apply options")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
if _, err := NewProvider().Generate(context.Background(), &ai.Request{Prompt: "hi"}); err == nil {
|
||||
t.Error("expected error without API key")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
if _, err := NewProvider().Stream(context.Background(), &ai.Request{Prompt: "hi"}); err == nil {
|
||||
t.Error("expected error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Registration(t *testing.T) {
|
||||
m := ai.New("mistral", ai.WithAPIKey("test"))
|
||||
if m == nil {
|
||||
t.Fatal("provider not registered")
|
||||
}
|
||||
if m.String() != "mistral" {
|
||||
t.Errorf("got %q", m.String())
|
||||
}
|
||||
}
|
||||
-205
@@ -1,205 +0,0 @@
|
||||
// Package ai provides abstraction for AI model providers
|
||||
package ai
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Model provides an interface for interacting with AI model providers
|
||||
type Model interface {
|
||||
// Init initializes the model with options
|
||||
Init(...Option) error
|
||||
// Options returns the model options
|
||||
Options() Options
|
||||
// Generate generates a response from the model
|
||||
Generate(ctx context.Context, req *Request, opts ...GenerateOption) (*Response, error)
|
||||
// Stream generates a streaming response (for future implementation)
|
||||
Stream(ctx context.Context, req *Request, opts ...GenerateOption) (Stream, error)
|
||||
// String returns the name of the provider
|
||||
String() string
|
||||
}
|
||||
|
||||
// Tool represents a tool/function that can be called by the model
|
||||
type Tool struct {
|
||||
Name string // LLM-safe name (e.g., "greeter_Greeter_Hello")
|
||||
OriginalName string // Original name (e.g., "greeter.Greeter.Hello")
|
||||
Description string
|
||||
Properties map[string]any // JSON schema for tool parameters
|
||||
}
|
||||
|
||||
// Request represents a request to generate content from a model
|
||||
type Request struct {
|
||||
// Prompt is the user's message/prompt
|
||||
Prompt string
|
||||
// SystemPrompt is the system instruction for the model
|
||||
SystemPrompt string
|
||||
// Tools available for the model to use
|
||||
Tools []Tool
|
||||
// Messages for continuing a conversation (optional).
|
||||
// Use ai.History to accumulate these across turns.
|
||||
Messages []Message
|
||||
}
|
||||
|
||||
// Message represents a conversation message
|
||||
type Message struct {
|
||||
Role string // "user", "assistant", "system", "tool"
|
||||
Content any // Can be string or structured content
|
||||
}
|
||||
|
||||
// Response represents the response from a model
|
||||
type Response struct {
|
||||
// Reply is the text response from the model
|
||||
Reply string
|
||||
// ToolCalls are tool calls requested by the model
|
||||
ToolCalls []ToolCall
|
||||
// Answer is the final answer after tool execution (if tools were used)
|
||||
Answer string
|
||||
}
|
||||
|
||||
// ToolCall represents a request to call a tool and its result
|
||||
type ToolCall struct {
|
||||
ID string // Tool call ID (for correlation)
|
||||
Name string // Tool name
|
||||
Input map[string]any // Tool input arguments
|
||||
Result string // Tool execution result (populated after execution)
|
||||
Error string // Tool execution error (populated after execution)
|
||||
}
|
||||
|
||||
// Scan decodes the call's Input into v (a pointer to a struct or map),
|
||||
// the same way a codec decodes an RPC request body. Use it when a tool
|
||||
// wants typed arguments instead of the raw map:
|
||||
//
|
||||
// var args struct{ Query string `json:"query"` }
|
||||
// if err := call.Scan(&args); err != nil { ... }
|
||||
func (c ToolCall) Scan(v any) error {
|
||||
b, err := json.Marshal(c.Input)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return json.Unmarshal(b, v)
|
||||
}
|
||||
|
||||
// ToolResult represents the result of a tool execution
|
||||
type ToolResult struct {
|
||||
ID string // Tool call ID (for correlation)
|
||||
Value any // Structured result (optional)
|
||||
Content string // Tool execution result (JSON string), shown to the model
|
||||
// Refused names the reason a guardrail blocked the call before it ran
|
||||
// ("max_steps", "loop", "approval"); empty when the call executed. A
|
||||
// tool wrapper can switch on it to build reliability tooling — react to
|
||||
// a detected loop, audit refusals — without parsing the message.
|
||||
Refused string `json:"refused,omitempty"`
|
||||
}
|
||||
|
||||
// Refusal reason codes set on ToolResult.Refused by the agent's guardrails.
|
||||
const (
|
||||
RefusedMaxSteps = "max_steps"
|
||||
RefusedLoop = "loop"
|
||||
RefusedApproval = "approval"
|
||||
)
|
||||
|
||||
// RunInfo describes the agent run a tool call belongs to. The agent
|
||||
// attaches it to the context passed to a ToolHandler, so a wrapper can
|
||||
// correlate calls within a run and across delegation without coupling to
|
||||
// the agent package. Per-call detail (tool name, id) is on the ToolCall;
|
||||
// step and attempt counts are naturally counted by the wrapper itself.
|
||||
type RunInfo struct {
|
||||
RunID string // correlation id for this agent run (one per Ask)
|
||||
ParentID string // the run that delegated to this one, if any
|
||||
Agent string // the agent's name
|
||||
}
|
||||
|
||||
type runInfoKey struct{}
|
||||
|
||||
// WithRunInfo attaches run info to ctx.
|
||||
func WithRunInfo(ctx context.Context, r RunInfo) context.Context {
|
||||
return context.WithValue(ctx, runInfoKey{}, r)
|
||||
}
|
||||
|
||||
// RunInfoFrom returns the run info attached to ctx, and whether it was set.
|
||||
func RunInfoFrom(ctx context.Context) (RunInfo, bool) {
|
||||
r, ok := ctx.Value(runInfoKey{}).(RunInfo)
|
||||
return r, ok
|
||||
}
|
||||
|
||||
// Stream is the interface for streaming responses (future implementation)
|
||||
type Stream interface {
|
||||
// Recv receives the next chunk of the response
|
||||
Recv() (*Response, error)
|
||||
// Close closes the stream
|
||||
Close() error
|
||||
}
|
||||
|
||||
// ToolHandler executes a tool call and returns its result. It mirrors a
|
||||
// go-micro RPC handler — context first, a request in, a result out — so
|
||||
// the same mental model carries over from services to tools.
|
||||
type ToolHandler func(ctx context.Context, call ToolCall) ToolResult
|
||||
|
||||
// ToolWrapper wraps a ToolHandler to add behaviour around execution —
|
||||
// logging, metrics, retries, guardrails. It is the tool-side analogue of
|
||||
// client.CallWrapper and server.HandlerWrapper: a wrapper takes the next
|
||||
// handler and returns a new one, and code before the next(...) call runs
|
||||
// before the tool, code after runs after.
|
||||
type ToolWrapper func(ToolHandler) ToolHandler
|
||||
|
||||
// NewFunc creates a new Model instance
|
||||
type NewFunc func(...Option) Model
|
||||
|
||||
var providers = make(map[string]NewFunc)
|
||||
|
||||
// Register registers a model provider
|
||||
func Register(name string, fn NewFunc) {
|
||||
providers[name] = fn
|
||||
}
|
||||
|
||||
// New creates a new Model instance based on the provider name
|
||||
func New(provider string, opts ...Option) Model {
|
||||
if fn, ok := providers[provider]; ok {
|
||||
return fn(opts...)
|
||||
}
|
||||
|
||||
// Default to first registered provider
|
||||
if len(providers) > 0 {
|
||||
for _, fn := range providers {
|
||||
return fn(opts...)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// AutoDetectProvider attempts to detect the provider from the base URL
|
||||
func AutoDetectProvider(baseURL string) string {
|
||||
if baseURL == "" {
|
||||
return "openai"
|
||||
}
|
||||
switch {
|
||||
case strings.Contains(baseURL, "anthropic"):
|
||||
return "anthropic"
|
||||
case strings.Contains(baseURL, "atlascloud"):
|
||||
return "atlascloud"
|
||||
case strings.Contains(baseURL, "googleapis.com"), strings.Contains(baseURL, "google"):
|
||||
return "gemini"
|
||||
case strings.Contains(baseURL, "groq"):
|
||||
return "groq"
|
||||
case strings.Contains(baseURL, "mistral"):
|
||||
return "mistral"
|
||||
case strings.Contains(baseURL, "together"):
|
||||
return "together"
|
||||
default:
|
||||
return "openai"
|
||||
}
|
||||
}
|
||||
|
||||
// DefaultModel is a default model instance
|
||||
var DefaultModel Model
|
||||
|
||||
// Generate generates a response using the default model.
|
||||
func Generate(ctx context.Context, req *Request, opts ...GenerateOption) (*Response, error) {
|
||||
if DefaultModel == nil {
|
||||
return nil, nil
|
||||
}
|
||||
return DefaultModel.Generate(ctx, req, opts...)
|
||||
}
|
||||
@@ -1,297 +0,0 @@
|
||||
// Package openai implements the OpenAI model provider
|
||||
package openai
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("openai", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
ai.RegisterImage("openai", func(opts ...ai.Option) ai.ImageModel {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
// Provider implements the ai.Model interface for OpenAI
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
// NewProvider creates a new OpenAI provider
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
|
||||
// Set defaults if not provided
|
||||
if options.Model == "" {
|
||||
options.Model = "gpt-4o"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://api.openai.com"
|
||||
}
|
||||
|
||||
return &Provider{
|
||||
opts: options,
|
||||
}
|
||||
}
|
||||
|
||||
// Init initializes the provider with options
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Options returns the provider options
|
||||
func (p *Provider) Options() ai.Options {
|
||||
return p.opts
|
||||
}
|
||||
|
||||
// String returns the provider name
|
||||
func (p *Provider) String() string {
|
||||
return "openai"
|
||||
}
|
||||
|
||||
// Generate generates a response from the model
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
// Build tools for OpenAI format
|
||||
var openaiTools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
openaiTools = append(openaiTools, map[string]any{
|
||||
"type": "function",
|
||||
"function": map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"parameters": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
// Build messages
|
||||
messages := []map[string]any{
|
||||
{"role": "system", "content": req.SystemPrompt},
|
||||
{"role": "user", "content": req.Prompt},
|
||||
}
|
||||
|
||||
// Build initial request
|
||||
apiReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": messages,
|
||||
}
|
||||
|
||||
if len(openaiTools) > 0 {
|
||||
apiReq["tools"] = openaiTools
|
||||
}
|
||||
|
||||
// Make API call
|
||||
resp, rawMessage, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// If no tool calls, return response
|
||||
if len(resp.ToolCalls) == 0 {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
// If tool handler is provided, execute tools and get final answer
|
||||
if p.opts.ToolHandler != nil {
|
||||
// Build follow-up messages
|
||||
followUpMessages := append(messages, map[string]any{
|
||||
"role": "assistant",
|
||||
"content": rawMessage["content"],
|
||||
"tool_calls": rawMessage["tool_calls"],
|
||||
})
|
||||
|
||||
for _, tc := range resp.ToolCalls {
|
||||
content := p.opts.ToolHandler(ctx, tc).Content
|
||||
followUpMessages = append(followUpMessages, map[string]any{
|
||||
"role": "tool",
|
||||
"tool_call_id": tc.ID,
|
||||
"content": content,
|
||||
})
|
||||
}
|
||||
|
||||
followUpReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": followUpMessages,
|
||||
}
|
||||
|
||||
// Make follow-up API call
|
||||
followUpResp, _, err := p.callAPI(ctx, followUpReq)
|
||||
if err == nil && followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
// Stream generates a streaming response (not yet implemented)
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for openai provider")
|
||||
}
|
||||
|
||||
// callAPI makes an HTTP request to the OpenAI API
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, map[string]any, error) {
|
||||
// Marshal request
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
// Build HTTP request
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/chat/completions"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
// Set headers
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
// Make request
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
// Read response
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
// Parse response
|
||||
var chatResp struct {
|
||||
Choices []struct {
|
||||
Message struct {
|
||||
Content string `json:"content"`
|
||||
ToolCalls []struct {
|
||||
ID string `json:"id"`
|
||||
Function struct {
|
||||
Name string `json:"name"`
|
||||
Arguments string `json:"arguments"`
|
||||
} `json:"function"`
|
||||
} `json:"tool_calls"`
|
||||
} `json:"message"`
|
||||
} `json:"choices"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &chatResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
|
||||
if len(chatResp.Choices) == 0 {
|
||||
return nil, nil, fmt.Errorf("no response from API")
|
||||
}
|
||||
|
||||
choice := chatResp.Choices[0]
|
||||
response := &ai.Response{
|
||||
Reply: choice.Message.Content,
|
||||
}
|
||||
|
||||
// Extract tool calls
|
||||
for _, tc := range choice.Message.ToolCalls {
|
||||
var input map[string]any
|
||||
if err := json.Unmarshal([]byte(tc.Function.Arguments), &input); err != nil {
|
||||
input = map[string]any{}
|
||||
}
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: tc.ID,
|
||||
Name: tc.Function.Name,
|
||||
Input: input,
|
||||
})
|
||||
}
|
||||
|
||||
// Return raw message for potential follow-up
|
||||
rawMessage := map[string]any{
|
||||
"content": choice.Message.Content,
|
||||
"tool_calls": choice.Message.ToolCalls,
|
||||
}
|
||||
|
||||
return response, rawMessage, nil
|
||||
}
|
||||
|
||||
const defaultImageModel = "gpt-image-1"
|
||||
|
||||
func (p *Provider) GenerateImage(ctx context.Context, req *ai.ImageRequest, opts ...ai.GenerateOption) (*ai.ImageResponse, error) {
|
||||
model := req.Model
|
||||
if model == "" {
|
||||
model = defaultImageModel
|
||||
}
|
||||
n := req.N
|
||||
if n <= 0 {
|
||||
n = 1
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": model,
|
||||
"prompt": req.Prompt,
|
||||
"n": n,
|
||||
}
|
||||
if req.Size != "" {
|
||||
apiReq["size"] = req.Size
|
||||
}
|
||||
|
||||
reqBody, err := json.Marshal(apiReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/images/generations"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var imgResp struct {
|
||||
Data []struct {
|
||||
URL string `json:"url"`
|
||||
B64JSON string `json:"b64_json"`
|
||||
} `json:"data"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &imgResp); err != nil {
|
||||
return nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
|
||||
response := &ai.ImageResponse{}
|
||||
for _, d := range imgResp.Data {
|
||||
response.Images = append(response.Images, ai.Image{
|
||||
URL: d.URL,
|
||||
Base64: d.B64JSON,
|
||||
})
|
||||
}
|
||||
|
||||
return response, nil
|
||||
}
|
||||
@@ -1,116 +0,0 @@
|
||||
package openai
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if p.String() != "openai" {
|
||||
t.Errorf("Expected provider name 'openai', got '%s'", p.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
err := p.Init(
|
||||
ai.WithModel("test-model"),
|
||||
ai.WithAPIKey("test-key"),
|
||||
ai.WithBaseURL("https://test.com"),
|
||||
)
|
||||
|
||||
if err != nil {
|
||||
t.Fatalf("Init failed: %v", err)
|
||||
}
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "test-model" {
|
||||
t.Errorf("Expected model 'test-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "test-key" {
|
||||
t.Errorf("Expected API key 'test-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
if opts.BaseURL != "https://test.com" {
|
||||
t.Errorf("Expected base URL 'https://test.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Options(t *testing.T) {
|
||||
p := NewProvider(
|
||||
ai.WithModel("custom-model"),
|
||||
ai.WithAPIKey("my-key"),
|
||||
)
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "custom-model" {
|
||||
t.Errorf("Expected model 'custom-model', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.APIKey != "my-key" {
|
||||
t.Errorf("Expected API key 'my-key', got '%s'", opts.APIKey)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
opts := p.Options()
|
||||
if opts.Model != "gpt-4o" {
|
||||
t.Errorf("Expected default model 'gpt-4o', got '%s'", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://api.openai.com" {
|
||||
t.Errorf("Expected default base URL 'https://api.openai.com', got '%s'", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
SystemPrompt: "You are helpful",
|
||||
}
|
||||
|
||||
_, err := p.Generate(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
p := NewProvider()
|
||||
|
||||
req := &ai.Request{
|
||||
Prompt: "Hello",
|
||||
}
|
||||
|
||||
_, err := p.Stream(context.Background(), req)
|
||||
if err == nil {
|
||||
t.Error("Expected error for unimplemented streaming, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_ImageRegistration(t *testing.T) {
|
||||
ig := ai.NewImage("openai", ai.WithAPIKey("test"))
|
||||
if ig == nil {
|
||||
t.Fatal("ai.NewImage('openai') returned nil — image provider not registered")
|
||||
}
|
||||
if ig.String() != "openai" {
|
||||
t.Errorf("Expected 'openai', got '%s'", ig.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_GenerateImage_NoAPIKey(t *testing.T) {
|
||||
p := NewProvider()
|
||||
_, err := p.GenerateImage(context.Background(), &ai.ImageRequest{Prompt: "a cat"})
|
||||
if err == nil {
|
||||
t.Error("Expected error when API key is missing, got nil")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_ImplementsImageModel(t *testing.T) {
|
||||
var _ ai.ImageModel = (*Provider)(nil)
|
||||
}
|
||||
@@ -1,93 +0,0 @@
|
||||
package ai
|
||||
|
||||
import (
|
||||
"context"
|
||||
)
|
||||
|
||||
// Options for model configuration
|
||||
type Options struct {
|
||||
// Context for the model
|
||||
Context context.Context
|
||||
// Model name (e.g., "gpt-4o", "claude-sonnet-4-20250514")
|
||||
Model string
|
||||
// APIKey for authentication
|
||||
APIKey string
|
||||
// BaseURL for the API endpoint
|
||||
BaseURL string
|
||||
// ToolHandler handles tool calls (optional, for automatic tool execution)
|
||||
ToolHandler ToolHandler
|
||||
}
|
||||
|
||||
// GenerateOptions for generate call
|
||||
type GenerateOptions struct {
|
||||
// Context for this specific generate call
|
||||
Context context.Context
|
||||
}
|
||||
|
||||
// Option is a function that modifies Options
|
||||
type Option func(*Options)
|
||||
|
||||
// GenerateOption is a function that modifies GenerateOptions
|
||||
type GenerateOption func(*GenerateOptions)
|
||||
|
||||
// NewOptions creates new Options with defaults
|
||||
func NewOptions(opts ...Option) Options {
|
||||
options := Options{
|
||||
Context: context.Background(),
|
||||
}
|
||||
for _, o := range opts {
|
||||
o(&options)
|
||||
}
|
||||
return options
|
||||
}
|
||||
|
||||
// WithModel sets the model name
|
||||
func WithModel(m string) Option {
|
||||
return func(o *Options) {
|
||||
o.Model = m
|
||||
}
|
||||
}
|
||||
|
||||
// WithAPIKey sets the API key
|
||||
func WithAPIKey(key string) Option {
|
||||
return func(o *Options) {
|
||||
o.APIKey = key
|
||||
}
|
||||
}
|
||||
|
||||
// WithBaseURL sets the base URL
|
||||
func WithBaseURL(url string) Option {
|
||||
return func(o *Options) {
|
||||
o.BaseURL = url
|
||||
}
|
||||
}
|
||||
|
||||
// WithContext sets the context
|
||||
func WithContext(ctx context.Context) Option {
|
||||
return func(o *Options) {
|
||||
o.Context = ctx
|
||||
}
|
||||
}
|
||||
|
||||
// WithToolHandler sets the tool handler
|
||||
func WithToolHandler(handler ToolHandler) Option {
|
||||
return func(o *Options) {
|
||||
o.ToolHandler = handler
|
||||
}
|
||||
}
|
||||
|
||||
// WithTools wires a Tools instance into the model, setting the tool
|
||||
// handler so the model can execute discovered service endpoints. The
|
||||
// tool list itself is passed per-request via Request.Tools.
|
||||
//
|
||||
// tools := ai.NewTools(service.Registry())
|
||||
// list, _ := tools.Discover()
|
||||
// m := ai.New("anthropic", ai.WithAPIKey(key), ai.WithTools(tools))
|
||||
// resp, _ := m.Generate(ctx, &ai.Request{Prompt: input, Tools: list})
|
||||
func WithTools(t *Tools) Option {
|
||||
return func(o *Options) {
|
||||
if t != nil {
|
||||
o.ToolHandler = t.Handler()
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,194 +0,0 @@
|
||||
// Package together implements the Together AI model provider.
|
||||
//
|
||||
// Together AI provides fast inference for open-weight models via an
|
||||
// OpenAI-compatible chat completions endpoint.
|
||||
//
|
||||
// Usage:
|
||||
//
|
||||
// import _ "go-micro.dev/v6/ai/together"
|
||||
//
|
||||
// m := ai.New("together",
|
||||
// ai.WithAPIKey("your-api-key"),
|
||||
// )
|
||||
package together
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func init() {
|
||||
ai.Register("together", func(opts ...ai.Option) ai.Model {
|
||||
return NewProvider(opts...)
|
||||
})
|
||||
}
|
||||
|
||||
type Provider struct {
|
||||
opts ai.Options
|
||||
}
|
||||
|
||||
func NewProvider(opts ...ai.Option) *Provider {
|
||||
options := ai.NewOptions(opts...)
|
||||
if options.Model == "" {
|
||||
options.Model = "meta-llama/Llama-3.3-70B-Instruct-Turbo"
|
||||
}
|
||||
if options.BaseURL == "" {
|
||||
options.BaseURL = "https://api.together.xyz"
|
||||
}
|
||||
return &Provider{opts: options}
|
||||
}
|
||||
|
||||
func (p *Provider) Init(opts ...ai.Option) error {
|
||||
for _, o := range opts {
|
||||
o(&p.opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *Provider) Options() ai.Options { return p.opts }
|
||||
func (p *Provider) String() string { return "together" }
|
||||
|
||||
func (p *Provider) Generate(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (*ai.Response, error) {
|
||||
var tools []map[string]any
|
||||
for _, t := range req.Tools {
|
||||
tools = append(tools, map[string]any{
|
||||
"type": "function",
|
||||
"function": map[string]any{
|
||||
"name": t.Name,
|
||||
"description": t.Description,
|
||||
"parameters": map[string]any{
|
||||
"type": "object",
|
||||
"properties": t.Properties,
|
||||
},
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
messages := []map[string]any{
|
||||
{"role": "system", "content": req.SystemPrompt},
|
||||
{"role": "user", "content": req.Prompt},
|
||||
}
|
||||
|
||||
apiReq := map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": messages,
|
||||
}
|
||||
if len(tools) > 0 {
|
||||
apiReq["tools"] = tools
|
||||
}
|
||||
|
||||
resp, rawMessage, err := p.callAPI(ctx, apiReq)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(resp.ToolCalls) == 0 {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
if p.opts.ToolHandler != nil {
|
||||
followUpMessages := append(messages, map[string]any{
|
||||
"role": "assistant",
|
||||
"content": rawMessage["content"],
|
||||
"tool_calls": rawMessage["tool_calls"],
|
||||
})
|
||||
for _, tc := range resp.ToolCalls {
|
||||
content := p.opts.ToolHandler(ctx, tc).Content
|
||||
followUpMessages = append(followUpMessages, map[string]any{
|
||||
"role": "tool",
|
||||
"tool_call_id": tc.ID,
|
||||
"content": content,
|
||||
})
|
||||
}
|
||||
followUpResp, _, err := p.callAPI(ctx, map[string]any{
|
||||
"model": p.opts.Model,
|
||||
"messages": followUpMessages,
|
||||
})
|
||||
if err == nil && followUpResp.Reply != "" {
|
||||
resp.Answer = followUpResp.Reply
|
||||
}
|
||||
}
|
||||
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
func (p *Provider) Stream(ctx context.Context, req *ai.Request, opts ...ai.GenerateOption) (ai.Stream, error) {
|
||||
return nil, fmt.Errorf("streaming not yet implemented for together provider")
|
||||
}
|
||||
|
||||
func (p *Provider) callAPI(ctx context.Context, req map[string]any) (*ai.Response, map[string]any, error) {
|
||||
reqBody, err := json.Marshal(req)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to marshal request: %w", err)
|
||||
}
|
||||
|
||||
apiURL := strings.TrimRight(p.opts.BaseURL, "/") + "/v1/chat/completions"
|
||||
httpReq, err := http.NewRequestWithContext(ctx, "POST", apiURL, bytes.NewReader(reqBody))
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
|
||||
httpReq.Header.Set("Content-Type", "application/json")
|
||||
httpReq.Header.Set("Authorization", "Bearer "+p.opts.APIKey)
|
||||
|
||||
httpResp, err := http.DefaultClient.Do(httpReq)
|
||||
if err != nil {
|
||||
return nil, nil, fmt.Errorf("API request failed: %w", err)
|
||||
}
|
||||
defer httpResp.Body.Close()
|
||||
|
||||
respBody, _ := io.ReadAll(httpResp.Body)
|
||||
if httpResp.StatusCode != 200 {
|
||||
return nil, nil, fmt.Errorf("API error (%s): %s", httpResp.Status, string(respBody))
|
||||
}
|
||||
|
||||
var chatResp struct {
|
||||
Choices []struct {
|
||||
Message struct {
|
||||
Content string `json:"content"`
|
||||
ToolCalls []struct {
|
||||
ID string `json:"id"`
|
||||
Function struct {
|
||||
Name string `json:"name"`
|
||||
Arguments string `json:"arguments"`
|
||||
} `json:"function"`
|
||||
} `json:"tool_calls"`
|
||||
} `json:"message"`
|
||||
} `json:"choices"`
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(respBody, &chatResp); err != nil {
|
||||
return nil, nil, fmt.Errorf("failed to parse response: %w", err)
|
||||
}
|
||||
if len(chatResp.Choices) == 0 {
|
||||
return nil, nil, fmt.Errorf("no response from API")
|
||||
}
|
||||
|
||||
choice := chatResp.Choices[0]
|
||||
response := &ai.Response{Reply: choice.Message.Content}
|
||||
|
||||
for _, tc := range choice.Message.ToolCalls {
|
||||
var input map[string]any
|
||||
if err := json.Unmarshal([]byte(tc.Function.Arguments), &input); err != nil {
|
||||
input = map[string]any{}
|
||||
}
|
||||
response.ToolCalls = append(response.ToolCalls, ai.ToolCall{
|
||||
ID: tc.ID,
|
||||
Name: tc.Function.Name,
|
||||
Input: input,
|
||||
})
|
||||
}
|
||||
|
||||
rawMessage := map[string]any{
|
||||
"content": choice.Message.Content,
|
||||
"tool_calls": choice.Message.ToolCalls,
|
||||
}
|
||||
|
||||
return response, rawMessage, nil
|
||||
}
|
||||
@@ -1,56 +0,0 @@
|
||||
package together
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/ai"
|
||||
)
|
||||
|
||||
func TestProvider_String(t *testing.T) {
|
||||
if NewProvider().String() != "together" {
|
||||
t.Errorf("got %q", NewProvider().String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Defaults(t *testing.T) {
|
||||
opts := NewProvider().Options()
|
||||
if opts.Model != "meta-llama/Llama-3.3-70B-Instruct-Turbo" {
|
||||
t.Errorf("default model = %q", opts.Model)
|
||||
}
|
||||
if opts.BaseURL != "https://api.together.xyz" {
|
||||
t.Errorf("default base URL = %q", opts.BaseURL)
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Init(t *testing.T) {
|
||||
p := NewProvider()
|
||||
if err := p.Init(ai.WithModel("m"), ai.WithAPIKey("k")); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if p.Options().Model != "m" || p.Options().APIKey != "k" {
|
||||
t.Error("Init did not apply options")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Generate_NoAPIKey(t *testing.T) {
|
||||
if _, err := NewProvider().Generate(context.Background(), &ai.Request{Prompt: "hi"}); err == nil {
|
||||
t.Error("expected error without API key")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Stream_NotImplemented(t *testing.T) {
|
||||
if _, err := NewProvider().Stream(context.Background(), &ai.Request{Prompt: "hi"}); err == nil {
|
||||
t.Error("expected error")
|
||||
}
|
||||
}
|
||||
|
||||
func TestProvider_Registration(t *testing.T) {
|
||||
m := ai.New("together", ai.WithAPIKey("test"))
|
||||
if m == nil {
|
||||
t.Fatal("provider not registered")
|
||||
}
|
||||
if m.String() != "together" {
|
||||
t.Errorf("got %q", m.String())
|
||||
}
|
||||
}
|
||||
-185
@@ -1,185 +0,0 @@
|
||||
package ai
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"strings"
|
||||
"sync"
|
||||
|
||||
"go-micro.dev/v6/client"
|
||||
codecBytes "go-micro.dev/v6/codec/bytes"
|
||||
"go-micro.dev/v6/registry"
|
||||
)
|
||||
|
||||
type toolNameMap struct {
|
||||
mu sync.RWMutex
|
||||
m map[string]string
|
||||
}
|
||||
|
||||
func (n *toolNameMap) put(safe, original string) {
|
||||
n.mu.Lock()
|
||||
n.m[safe] = original
|
||||
n.mu.Unlock()
|
||||
}
|
||||
|
||||
func (n *toolNameMap) get(safe string) (string, bool) {
|
||||
n.mu.RLock()
|
||||
v, ok := n.m[safe]
|
||||
n.mu.RUnlock()
|
||||
return v, ok
|
||||
}
|
||||
|
||||
// Tools discovers go-micro services from a registry and converts their
|
||||
// endpoints into Tool definitions. It also executes tool calls via RPC.
|
||||
//
|
||||
// Create with NewTools, discover the tool list with Discover, and wire
|
||||
// execution into a model with WithTools:
|
||||
//
|
||||
// tools := ai.NewTools(service.Registry())
|
||||
// list, _ := tools.Discover()
|
||||
// m := ai.New("anthropic", ai.WithAPIKey(key), ai.WithTools(tools))
|
||||
// resp, _ := m.Generate(ctx, &ai.Request{Prompt: input, Tools: list})
|
||||
type Tools struct {
|
||||
registry registry.Registry
|
||||
client client.Client
|
||||
names *toolNameMap
|
||||
}
|
||||
|
||||
// ToolOption configures a Tools instance.
|
||||
type ToolOption func(*Tools)
|
||||
|
||||
// ToolClient sets the client used to execute tool calls. Defaults to
|
||||
// client.DefaultClient.
|
||||
func ToolClient(c client.Client) ToolOption {
|
||||
return func(t *Tools) {
|
||||
if c != nil {
|
||||
t.client = c
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// NewTools creates a Tools bound to the given registry.
|
||||
func NewTools(reg registry.Registry, opts ...ToolOption) *Tools {
|
||||
t := &Tools{
|
||||
registry: reg,
|
||||
client: client.DefaultClient,
|
||||
names: &toolNameMap{m: map[string]string{}},
|
||||
}
|
||||
for _, o := range opts {
|
||||
o(t)
|
||||
}
|
||||
return t
|
||||
}
|
||||
|
||||
// Discover walks the registry and returns one Tool per service
|
||||
// endpoint. Tool names are LLM-safe (dots replaced with underscores).
|
||||
func (t *Tools) Discover() ([]Tool, error) {
|
||||
services, err := t.registry.ListServices()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var out []Tool
|
||||
for _, svc := range services {
|
||||
full, err := t.registry.GetService(svc.Name)
|
||||
if err != nil || len(full) == 0 {
|
||||
continue
|
||||
}
|
||||
for _, ep := range full[0].Endpoints {
|
||||
original := fmt.Sprintf("%s.%s", svc.Name, ep.Name)
|
||||
safe := strings.ReplaceAll(original, ".", "_")
|
||||
t.names.put(safe, original)
|
||||
|
||||
desc := fmt.Sprintf("Call %s on %s service", ep.Name, svc.Name)
|
||||
if ep.Metadata != nil {
|
||||
if d, ok := ep.Metadata["description"]; ok && d != "" {
|
||||
desc = d
|
||||
}
|
||||
}
|
||||
|
||||
props := map[string]any{}
|
||||
if ep.Request != nil {
|
||||
for _, field := range ep.Request.Values {
|
||||
props[field.Name] = map[string]any{
|
||||
"type": toolJSONType(field.Type),
|
||||
"description": fmt.Sprintf("%s (%s)", field.Name, field.Type),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
out = append(out, Tool{
|
||||
Name: safe,
|
||||
OriginalName: original,
|
||||
Description: desc,
|
||||
Properties: props,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
return out, nil
|
||||
}
|
||||
|
||||
// Handler returns a ToolHandler that executes tool calls via RPC using
|
||||
// the configured client. Tool names may be LLM-safe (underscored) or
|
||||
// original (dotted). WithTools uses this internally.
|
||||
func (t *Tools) Handler() ToolHandler {
|
||||
c := t.client
|
||||
if c == nil {
|
||||
c = client.DefaultClient
|
||||
}
|
||||
return func(ctx context.Context, call ToolCall) ToolResult {
|
||||
name := call.Name
|
||||
if orig, ok := t.names.get(name); ok {
|
||||
name = orig
|
||||
}
|
||||
parts := strings.SplitN(name, ".", 2)
|
||||
if len(parts) != 2 {
|
||||
return toolErrResult(call.ID, "invalid tool name: "+name)
|
||||
}
|
||||
|
||||
inputBytes, err := json.Marshal(call.Input)
|
||||
if err != nil {
|
||||
return toolErrResult(call.ID, "failed to marshal input: "+err.Error())
|
||||
}
|
||||
|
||||
req := c.NewRequest(parts[0], parts[1], &codecBytes.Frame{Data: inputBytes})
|
||||
var rsp codecBytes.Frame
|
||||
if err := c.Call(ctx, req, &rsp); err != nil {
|
||||
return toolErrResult(call.ID, err.Error())
|
||||
}
|
||||
|
||||
var result any
|
||||
if err := json.Unmarshal(rsp.Data, &result); err != nil {
|
||||
result = string(rsp.Data)
|
||||
}
|
||||
return ToolResult{ID: call.ID, Value: result, Content: string(rsp.Data)}
|
||||
}
|
||||
}
|
||||
|
||||
// DiscoverTools is a convenience that discovers tools from a registry
|
||||
// without creating a Tools instance. For paired discovery + execution,
|
||||
// create a Tools with NewTools instead.
|
||||
func DiscoverTools(reg registry.Registry) ([]Tool, error) {
|
||||
return NewTools(reg).Discover()
|
||||
}
|
||||
|
||||
func toolErrResult(id, msg string) ToolResult {
|
||||
encoded, _ := json.Marshal(map[string]string{"error": msg})
|
||||
return ToolResult{ID: id, Value: map[string]string{"error": msg}, Content: string(encoded)}
|
||||
}
|
||||
|
||||
func toolJSONType(goType string) string {
|
||||
switch goType {
|
||||
case "string":
|
||||
return "string"
|
||||
case "int", "int32", "int64", "uint", "uint32", "uint64":
|
||||
return "integer"
|
||||
case "float32", "float64":
|
||||
return "number"
|
||||
case "bool":
|
||||
return "boolean"
|
||||
default:
|
||||
return "object"
|
||||
}
|
||||
}
|
||||
@@ -1,116 +0,0 @@
|
||||
package ai
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/registry"
|
||||
)
|
||||
|
||||
func TestToolJSONType(t *testing.T) {
|
||||
cases := map[string]string{
|
||||
"string": "string",
|
||||
"int": "integer",
|
||||
"int64": "integer",
|
||||
"float64": "number",
|
||||
"bool": "boolean",
|
||||
"User": "object",
|
||||
"": "object",
|
||||
}
|
||||
for in, want := range cases {
|
||||
if got := toolJSONType(in); got != want {
|
||||
t.Errorf("toolJSONType(%q) = %q, want %q", in, got, want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestDiscoverTools_Empty(t *testing.T) {
|
||||
reg := registry.NewMemoryRegistry()
|
||||
tools, err := DiscoverTools(reg)
|
||||
if err != nil {
|
||||
t.Fatalf("DiscoverTools: %v", err)
|
||||
}
|
||||
if len(tools) != 0 {
|
||||
t.Errorf("expected 0 tools, got %d", len(tools))
|
||||
}
|
||||
}
|
||||
|
||||
func TestDiscoverTools_DiscoversEndpoints(t *testing.T) {
|
||||
reg := registry.NewMemoryRegistry()
|
||||
svc := ®istry.Service{
|
||||
Name: "users",
|
||||
Version: "1.0.0",
|
||||
Nodes: []*registry.Node{
|
||||
{Id: "users-1", Address: "127.0.0.1:9000"},
|
||||
},
|
||||
Endpoints: []*registry.Endpoint{
|
||||
{
|
||||
Name: "Users.Get",
|
||||
Metadata: map[string]string{
|
||||
"description": "Fetch a user by ID",
|
||||
},
|
||||
Request: ®istry.Value{
|
||||
Name: "GetRequest",
|
||||
Type: "GetRequest",
|
||||
Values: []*registry.Value{
|
||||
{Name: "id", Type: "string"},
|
||||
{Name: "expand", Type: "bool"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
if err := reg.Register(svc); err != nil {
|
||||
t.Fatalf("Register: %v", err)
|
||||
}
|
||||
|
||||
tools, err := DiscoverTools(reg)
|
||||
if err != nil {
|
||||
t.Fatalf("DiscoverTools: %v", err)
|
||||
}
|
||||
if len(tools) != 1 {
|
||||
t.Fatalf("expected 1 tool, got %d", len(tools))
|
||||
}
|
||||
|
||||
tool := tools[0]
|
||||
if tool.Name != "users_Users_Get" {
|
||||
t.Errorf("safe name = %q", tool.Name)
|
||||
}
|
||||
if tool.OriginalName != "users.Users.Get" {
|
||||
t.Errorf("original = %q", tool.OriginalName)
|
||||
}
|
||||
if tool.Description != "Fetch a user by ID" {
|
||||
t.Errorf("description = %q", tool.Description)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTools_HandlerResolvesSafeName(t *testing.T) {
|
||||
tools := NewTools(registry.NewMemoryRegistry())
|
||||
tools.names.put("users_Users_Get", "users.Users.Get")
|
||||
|
||||
resolved, ok := tools.names.get("users_Users_Get")
|
||||
if !ok || resolved != "users.Users.Get" {
|
||||
t.Errorf("name map lookup = (%q, %v)", resolved, ok)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTools_HandlerInvalidName(t *testing.T) {
|
||||
tools := NewTools(registry.NewMemoryRegistry())
|
||||
h := tools.Handler()
|
||||
|
||||
res := h(context.Background(), ToolCall{Name: "foo", Input: map[string]any{}})
|
||||
if res.Value == nil {
|
||||
t.Fatal("expected error result")
|
||||
}
|
||||
if res.Content == "" {
|
||||
t.Error("expected non-empty content")
|
||||
}
|
||||
}
|
||||
|
||||
func TestWithTools(t *testing.T) {
|
||||
tools := NewTools(registry.NewMemoryRegistry())
|
||||
opts := NewOptions(WithTools(tools))
|
||||
if opts.ToolHandler == nil {
|
||||
t.Error("WithTools did not set a ToolHandler")
|
||||
}
|
||||
}
|
||||
-51
@@ -1,51 +0,0 @@
|
||||
package ai
|
||||
|
||||
import "context"
|
||||
|
||||
// VideoModel provides an interface for video generation providers.
|
||||
// Providers that support video generation implement this alongside
|
||||
// Model and/or ImageModel.
|
||||
type VideoModel interface {
|
||||
GenerateVideo(ctx context.Context, req *VideoRequest, opts ...GenerateOption) (*VideoResponse, error)
|
||||
String() string
|
||||
}
|
||||
|
||||
// VideoRequest describes what video to generate.
|
||||
type VideoRequest struct {
|
||||
// Prompt is the text description or instructions for the video.
|
||||
Prompt string
|
||||
// Model overrides the provider's default video model.
|
||||
Model string
|
||||
// Images are reference image URLs for image-to-video generation.
|
||||
Images []string
|
||||
// Duration in seconds. Provider-specific defaults apply.
|
||||
Duration int
|
||||
// AspectRatio (e.g. "16:9", "9:16"). Provider-specific.
|
||||
AspectRatio string
|
||||
// Resolution (e.g. "720p", "1080p"). Provider-specific.
|
||||
Resolution string
|
||||
}
|
||||
|
||||
// VideoResponse holds the generated video.
|
||||
type VideoResponse struct {
|
||||
// URL is the remote URL where the video can be fetched.
|
||||
URL string
|
||||
}
|
||||
|
||||
// NewVideoFunc creates a new VideoModel instance.
|
||||
type NewVideoFunc func(...Option) VideoModel
|
||||
|
||||
var videoProviders = make(map[string]NewVideoFunc)
|
||||
|
||||
// RegisterVideo registers a video generation provider.
|
||||
func RegisterVideo(name string, fn NewVideoFunc) {
|
||||
videoProviders[name] = fn
|
||||
}
|
||||
|
||||
// NewVideo creates a new VideoModel instance based on the provider name.
|
||||
func NewVideo(provider string, opts ...Option) VideoModel {
|
||||
if fn, ok := videoProviders[provider]; ok {
|
||||
return fn(opts...)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -1,345 +0,0 @@
|
||||
# Auth Package Analysis
|
||||
|
||||
## Current Status: ✅ Fully Functional
|
||||
|
||||
The auth package is now **production-ready** with complete server/client wrappers and integration examples.
|
||||
|
||||
---
|
||||
|
||||
## ✅ What Exists
|
||||
|
||||
### 1. Core Interfaces (`auth.go`)
|
||||
|
||||
```go
|
||||
type Auth interface {
|
||||
Generate(id string, opts ...GenerateOption) (*Account, error)
|
||||
Inspect(token string) (*Account, error)
|
||||
Token(opts ...TokenOption) (*Token, error)
|
||||
}
|
||||
|
||||
type Rules interface {
|
||||
Verify(acc *Account, res *Resource, opts ...VerifyOption) error
|
||||
Grant(rule *Rule) error
|
||||
Revoke(rule *Rule) error
|
||||
List(...ListOption) ([]*Rule, error)
|
||||
}
|
||||
```
|
||||
|
||||
**Status:** ✅ Well-designed, complete
|
||||
|
||||
### 2. Data Types
|
||||
|
||||
- `Account` - represents authenticated user/service
|
||||
- `Token` - access/refresh token pair
|
||||
- `Resource` - service endpoint to protect
|
||||
- `Rule` - access control rule
|
||||
- `Access` - grant/deny enum
|
||||
|
||||
**Status:** ✅ Complete
|
||||
|
||||
### 3. Implementations
|
||||
|
||||
**Noop Auth** (`noop.go`):
|
||||
- For development/testing
|
||||
- Always grants access
|
||||
- No actual authentication
|
||||
|
||||
**Status:** ✅ Works for dev
|
||||
|
||||
**JWT Auth** (`jwt/jwt.go`):
|
||||
- Uses RSA keys for signing
|
||||
- Generates and verifies JWT tokens
|
||||
- **⚠️ Problem:** Depends on external plugin `github.com/micro/plugins/v5/auth/jwt/token`
|
||||
|
||||
**Status:** ⚠️ External dependency
|
||||
|
||||
### 4. Authorization Logic (`rules.go`)
|
||||
|
||||
- Rule-based access control (RBAC)
|
||||
- Supports wildcards (`*`)
|
||||
- Priority-based rule evaluation
|
||||
- Scope-based permissions
|
||||
|
||||
**Status:** ✅ Complete and tested
|
||||
|
||||
---
|
||||
|
||||
## ✅ Recently Completed
|
||||
|
||||
### 1. **Service Integration Wrapper** ✅
|
||||
|
||||
**Status:** IMPLEMENTED in `wrapper/auth/server.go`
|
||||
|
||||
```go
|
||||
// AuthHandler wraps a service to enforce authentication
|
||||
func AuthHandler(opts HandlerOptions) server.HandlerWrapper
|
||||
func PublicEndpoints(...) HandlerOptions
|
||||
func AuthRequired(...) HandlerOptions
|
||||
func AuthOptional(authProvider auth.Auth) server.HandlerWrapper
|
||||
```
|
||||
|
||||
Features:
|
||||
- Token extraction from metadata
|
||||
- Token verification with auth.Inspect()
|
||||
- Authorization checks with rules.Verify()
|
||||
- Account injection into context
|
||||
- Skip endpoints support
|
||||
- Comprehensive error handling (401/403)
|
||||
|
||||
### 2. **Client Wrapper** ✅
|
||||
|
||||
**Status:** IMPLEMENTED in `wrapper/auth/client.go`
|
||||
|
||||
```go
|
||||
// AuthClient adds authentication tokens to client requests
|
||||
func AuthClient(opts ClientOptions) client.Wrapper
|
||||
func FromToken(token string) client.Wrapper
|
||||
func FromContext(authProvider auth.Auth) client.Wrapper
|
||||
```
|
||||
|
||||
Features:
|
||||
- Automatic token injection
|
||||
- Static token support
|
||||
- Dynamic token generation from context
|
||||
- Works with Call, Stream, and Publish
|
||||
|
||||
### 3. **Metadata Helpers** ✅
|
||||
|
||||
**Status:** IMPLEMENTED in `wrapper/auth/metadata.go`
|
||||
|
||||
```go
|
||||
// Standard token extraction and injection
|
||||
func TokenFromMetadata(md metadata.Metadata) (string, error)
|
||||
func TokenToMetadata(md metadata.Metadata, token string) metadata.Metadata
|
||||
func AccountFromMetadata(md metadata.Metadata, a auth.Auth) (*auth.Account, error)
|
||||
```
|
||||
|
||||
Features:
|
||||
- Bearer token extraction
|
||||
- Case-insensitive header lookup
|
||||
- Token format validation
|
||||
- Direct account extraction
|
||||
|
||||
### 6. **Standalone JWT Implementation** ⚠️
|
||||
|
||||
**Status:** Partially complete (low priority)
|
||||
|
||||
Current JWT auth in `auth/jwt/jwt.go` depends on external plugin:
|
||||
```go
|
||||
jwtToken "github.com/micro/plugins/v5/auth/jwt/token"
|
||||
```
|
||||
|
||||
**Note:** This is NOT a blocker. The wrappers work with any auth.Auth implementation including:
|
||||
- JWT auth (with plugin dependency)
|
||||
- Noop auth (for development)
|
||||
- Custom auth implementations
|
||||
|
||||
**Future improvement:** Create self-contained JWT implementation to remove plugin dependency.
|
||||
|
||||
### 4. **Examples** ✅
|
||||
|
||||
**Status:** IMPLEMENTED in `examples/auth/`
|
||||
|
||||
Complete working example with:
|
||||
- Protected Greeter service (server/)
|
||||
- Client with authentication (client/)
|
||||
- Proto definitions (proto/)
|
||||
- Comprehensive README with:
|
||||
- Architecture diagrams
|
||||
- Code walkthrough
|
||||
- Auth strategies
|
||||
- Authorization rules
|
||||
- Testing guide
|
||||
- Production considerations
|
||||
- Troubleshooting guide
|
||||
|
||||
### 5. **Documentation** ✅
|
||||
|
||||
**Status:** IMPLEMENTED
|
||||
|
||||
Complete documentation:
|
||||
- `wrapper/auth/README.md` - Full API reference (200+ lines)
|
||||
- `examples/auth/README.md` - Integration tutorial (400+ lines)
|
||||
- Server wrapper documentation with examples
|
||||
- Client wrapper documentation with examples
|
||||
- Metadata helpers API reference
|
||||
- Best practices guide
|
||||
- Troubleshooting guide
|
||||
- Production considerations
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Detailed Analysis
|
||||
|
||||
### JWT Implementation Dependency Issue
|
||||
|
||||
File: `auth/jwt/jwt.go:7`
|
||||
```go
|
||||
jwtToken "github.com/micro/plugins/v5/auth/jwt/token"
|
||||
```
|
||||
|
||||
This depends on:
|
||||
- `github.com/micro/plugins` repository
|
||||
- Must be separately installed
|
||||
- May not be maintained
|
||||
- Breaks self-contained promise
|
||||
|
||||
**Recommendation:** Create standalone JWT implementation in `auth/jwt/token/`
|
||||
|
||||
### Rules Verification Works Well
|
||||
|
||||
The `Verify()` function in `rules.go` is well-implemented:
|
||||
- ✅ Handles wildcards correctly
|
||||
- ✅ Priority-based evaluation
|
||||
- ✅ Supports resource hierarchies (e.g., `/foo/*` matches `/foo/bar`)
|
||||
- ✅ Public vs authenticated vs scoped access
|
||||
- ✅ Tested (see `rules_test.go`)
|
||||
|
||||
### Context Integration Exists
|
||||
|
||||
```go
|
||||
// From auth.go
|
||||
func AccountFromContext(ctx context.Context) (*Account, bool)
|
||||
func ContextWithAccount(ctx context.Context, account *Account) context.Context
|
||||
```
|
||||
|
||||
This is ready to use once wrappers are implemented.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Implementation Status
|
||||
|
||||
### Phase 1: Critical ✅ COMPLETE
|
||||
|
||||
1. ✅ **Server Wrapper** - `wrapper/auth/server.go`
|
||||
- Token extraction from metadata
|
||||
- Verification with auth.Inspect()
|
||||
- Authorization with rules.Verify()
|
||||
- Skip endpoints support
|
||||
- Helper functions (AuthRequired, PublicEndpoints, AuthOptional)
|
||||
|
||||
2. ✅ **Client Wrapper** - `wrapper/auth/client.go`
|
||||
- Adds Authorization header/metadata
|
||||
- Static token support (FromToken)
|
||||
- Dynamic token generation (FromContext)
|
||||
- Works with Call, Stream, Publish
|
||||
|
||||
3. ✅ **Metadata Helpers** - `wrapper/auth/metadata.go`
|
||||
- TokenFromMetadata - extract Bearer token
|
||||
- TokenToMetadata - inject Bearer token
|
||||
- AccountFromMetadata - extract and verify in one step
|
||||
|
||||
### Phase 2: Important ✅ COMPLETE
|
||||
|
||||
4. ⚠️ **Standalone JWT Implementation** - Deferred (not critical)
|
||||
- Current JWT works with plugin
|
||||
- Can use noop auth for development
|
||||
- Future enhancement to remove plugin dependency
|
||||
|
||||
5. ⚠️ **Key Generation Utilities** - Deferred (not critical)
|
||||
- JWT auth handles key management
|
||||
- Future enhancement for convenience
|
||||
|
||||
6. ✅ **Examples** - `examples/auth/`
|
||||
- Complete server/client example
|
||||
- Protected and public endpoints
|
||||
- Comprehensive README (400+ lines)
|
||||
- Code walkthrough and best practices
|
||||
|
||||
### Phase 3: Production Ready ✅ COMPLETE
|
||||
|
||||
7. ⚠️ **Advanced Examples** - Future enhancement
|
||||
- Basic example covers most use cases
|
||||
- Can be added based on demand
|
||||
|
||||
8. ✅ **Documentation**
|
||||
- `wrapper/auth/README.md` - Full API reference
|
||||
- `examples/auth/README.md` - Integration guide
|
||||
- Best practices and troubleshooting
|
||||
|
||||
9. ✅ **Testing Utilities**
|
||||
- Noop auth for tests
|
||||
- Token generation examples in docs
|
||||
|
||||
---
|
||||
|
||||
## 📋 Integration Checklist
|
||||
|
||||
To use auth with services, users need:
|
||||
|
||||
- [x] Auth interface and implementations
|
||||
- [x] **Server wrapper to enforce auth** ✅
|
||||
- [x] **Client wrapper to send auth** ✅
|
||||
- [x] Metadata helpers ✅
|
||||
- [x] Examples showing integration ✅
|
||||
- [x] Documentation ✅
|
||||
- [~] Working JWT implementation (has plugin dependency, not critical)
|
||||
|
||||
**Current completeness: ~95%** 🎉
|
||||
|
||||
The auth system is now fully functional and production-ready!
|
||||
|
||||
---
|
||||
|
||||
## 💡 Recommendations
|
||||
|
||||
### ✅ Completed
|
||||
|
||||
1. ✅ **Created wrapper/auth package** with server and client wrappers
|
||||
2. ✅ **Wrote comprehensive examples** showing protected service
|
||||
3. ✅ **Documented** integration patterns with 600+ lines of docs
|
||||
|
||||
### Optional Future Enhancements
|
||||
|
||||
4. **Remove plugin dependency** - create standalone JWT
|
||||
- Current solution works fine with plugin
|
||||
- Would reduce external dependencies
|
||||
- Priority: Low
|
||||
|
||||
5. **Add to CLI** - `micro auth` commands for token management
|
||||
- Generate tokens from CLI
|
||||
- Inspect tokens
|
||||
- Manage accounts
|
||||
- Priority: Medium
|
||||
|
||||
6. **OAuth2 provider** - for enterprise SSO
|
||||
- Integration with external identity providers
|
||||
- Priority: Low (can use custom auth provider)
|
||||
|
||||
7. **API key auth** - simpler alternative to JWT
|
||||
- For machine-to-machine auth
|
||||
- Priority: Low
|
||||
|
||||
8. **Audit logging** - track auth events
|
||||
- Who accessed what and when
|
||||
- Priority: Medium
|
||||
|
||||
9. **Rate limiting** - per account/scope
|
||||
- Prevent abuse
|
||||
- Priority: Medium
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Status: Auth System Complete
|
||||
|
||||
The auth system is now **fully functional and production-ready**!
|
||||
|
||||
**What's available:**
|
||||
- ✅ Server wrapper for enforcing auth
|
||||
- ✅ Client wrapper for adding auth
|
||||
- ✅ Metadata helpers for token handling
|
||||
- ✅ Complete working example
|
||||
- ✅ Comprehensive documentation
|
||||
- ✅ Best practices guide
|
||||
- ✅ Troubleshooting guide
|
||||
|
||||
**Usage:**
|
||||
```go
|
||||
// Server
|
||||
micro.WrapHandler(authWrapper.AuthHandler(...))
|
||||
|
||||
// Client
|
||||
micro.WrapClient(authWrapper.FromToken(...))
|
||||
```
|
||||
|
||||
See `examples/auth/` for complete working code!
|
||||
+3
-3
@@ -4,9 +4,9 @@ import (
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/auth"
|
||||
jwtToken "go-micro.dev/v6/auth/jwt/token"
|
||||
"go-micro.dev/v6/cmd"
|
||||
jwtToken "github.com/micro/plugins/v5/auth/jwt/token"
|
||||
"go-micro.dev/v5/auth"
|
||||
"go-micro.dev/v5/cmd"
|
||||
)
|
||||
|
||||
func init() {
|
||||
|
||||
@@ -4,8 +4,8 @@ import (
|
||||
"encoding/base64"
|
||||
"time"
|
||||
|
||||
"github.com/golang-jwt/jwt/v5"
|
||||
"go-micro.dev/v6/auth"
|
||||
"github.com/dgrijalva/jwt-go"
|
||||
"go-micro.dev/v5/auth"
|
||||
)
|
||||
|
||||
// authClaims to be encoded in the JWT.
|
||||
@@ -14,7 +14,7 @@ type authClaims struct {
|
||||
Scopes []string `json:"scopes"`
|
||||
Metadata map[string]string `json:"metadata"`
|
||||
|
||||
jwt.RegisteredClaims
|
||||
jwt.StandardClaims
|
||||
}
|
||||
|
||||
// JWT implementation of token provider.
|
||||
@@ -49,10 +49,10 @@ func (j *JWT) Generate(acc *auth.Account, opts ...GenerateOption) (*Token, error
|
||||
// generate the JWT
|
||||
expiry := time.Now().Add(options.Expiry)
|
||||
t := jwt.NewWithClaims(jwt.SigningMethodRS256, authClaims{
|
||||
acc.Type, acc.Scopes, acc.Metadata, jwt.RegisteredClaims{
|
||||
acc.Type, acc.Scopes, acc.Metadata, jwt.StandardClaims{
|
||||
Subject: acc.ID,
|
||||
Issuer: acc.Issuer,
|
||||
ExpiresAt: jwt.NewNumericDate(expiry),
|
||||
ExpiresAt: expiry.Unix(),
|
||||
},
|
||||
})
|
||||
tok, err := t.SignedString(key)
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/auth"
|
||||
"go-micro.dev/v5/auth"
|
||||
)
|
||||
|
||||
func TestGenerate(t *testing.T) {
|
||||
|
||||
@@ -3,7 +3,7 @@ package token
|
||||
import (
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/store"
|
||||
"go-micro.dev/v5/store"
|
||||
)
|
||||
|
||||
type Options struct {
|
||||
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"errors"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/auth"
|
||||
"go-micro.dev/v5/auth"
|
||||
)
|
||||
|
||||
var (
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
// Package noop provides a no-op auth implementation for testing and development.
|
||||
//
|
||||
// The noop auth provider:
|
||||
// - Accepts any token (always returns a valid account)
|
||||
// - Grants all permissions (no actual authorization)
|
||||
// - Generates tokens (but doesn't verify them)
|
||||
//
|
||||
// This is useful for:
|
||||
// - Local development
|
||||
// - Testing
|
||||
// - Prototyping
|
||||
//
|
||||
// DO NOT use in production. Use JWT auth or implement a custom auth provider instead.
|
||||
package noop
|
||||
|
||||
import (
|
||||
"go-micro.dev/v6/auth"
|
||||
)
|
||||
|
||||
// NewAuth returns a new noop auth provider.
|
||||
//
|
||||
// The noop provider accepts all tokens and grants all permissions.
|
||||
// This is for development and testing only - DO NOT use in production.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// authProvider := noop.NewAuth()
|
||||
// account, _ := authProvider.Generate("user123")
|
||||
// token, _ := authProvider.Token(auth.WithCredentials(account.ID, account.Secret))
|
||||
func NewAuth(opts ...auth.Option) auth.Auth {
|
||||
return auth.NewAuth(opts...)
|
||||
}
|
||||
|
||||
// NewRules returns a new noop rules implementation.
|
||||
//
|
||||
// The noop rules implementation grants all access and doesn't enforce any rules.
|
||||
// This is for development and testing only.
|
||||
//
|
||||
// Example:
|
||||
//
|
||||
// rules := noop.NewRules()
|
||||
// err := rules.Verify(account, resource) // Always returns nil
|
||||
func NewRules() auth.Rules {
|
||||
return auth.NewRules()
|
||||
}
|
||||
+1
-1
@@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v5/logger"
|
||||
)
|
||||
|
||||
func NewOptions(opts ...Option) Options {
|
||||
|
||||
+8
-8
@@ -15,14 +15,14 @@ import (
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"go-micro.dev/v6/codec/json"
|
||||
merr "go-micro.dev/v6/errors"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/registry/cache"
|
||||
"go-micro.dev/v6/transport/headers"
|
||||
maddr "go-micro.dev/v6/internal/util/addr"
|
||||
mnet "go-micro.dev/v6/internal/util/net"
|
||||
mls "go-micro.dev/v6/internal/util/tls"
|
||||
"go-micro.dev/v5/codec/json"
|
||||
merr "go-micro.dev/v5/errors"
|
||||
"go-micro.dev/v5/registry"
|
||||
"go-micro.dev/v5/registry/cache"
|
||||
"go-micro.dev/v5/transport/headers"
|
||||
maddr "go-micro.dev/v5/util/addr"
|
||||
mnet "go-micro.dev/v5/util/net"
|
||||
mls "go-micro.dev/v5/util/tls"
|
||||
"golang.org/x/net/http2"
|
||||
)
|
||||
|
||||
|
||||
+2
-2
@@ -6,8 +6,8 @@ import (
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/registry"
|
||||
)
|
||||
|
||||
var (
|
||||
|
||||
+4
-3
@@ -7,9 +7,9 @@ import (
|
||||
"sync"
|
||||
|
||||
"github.com/google/uuid"
|
||||
log "go-micro.dev/v6/logger"
|
||||
maddr "go-micro.dev/v6/internal/util/addr"
|
||||
mnet "go-micro.dev/v6/internal/util/net"
|
||||
log "go-micro.dev/v5/logger"
|
||||
maddr "go-micro.dev/v5/util/addr"
|
||||
mnet "go-micro.dev/v5/util/net"
|
||||
)
|
||||
|
||||
type memoryBroker struct {
|
||||
@@ -222,6 +222,7 @@ func (m *memorySubscriber) Unsubscribe() error {
|
||||
func NewMemoryBroker(opts ...Option) Broker {
|
||||
options := NewOptions(opts...)
|
||||
|
||||
|
||||
return &memoryBroker{
|
||||
opts: options,
|
||||
Subscribers: make(map[string][]*memorySubscriber),
|
||||
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v5/broker"
|
||||
)
|
||||
|
||||
func TestMemoryBroker(t *testing.T) {
|
||||
|
||||
@@ -3,7 +3,7 @@ package nats
|
||||
import (
|
||||
"context"
|
||||
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v5/broker"
|
||||
)
|
||||
|
||||
// setBrokerOption returns a function to setup a context with given value.
|
||||
|
||||
+6
-6
@@ -9,10 +9,10 @@ import (
|
||||
"time"
|
||||
|
||||
natsp "github.com/nats-io/nats.go"
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/codec/json"
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/codec/json"
|
||||
"go-micro.dev/v5/logger"
|
||||
"go-micro.dev/v5/registry"
|
||||
)
|
||||
|
||||
type natsBroker struct {
|
||||
@@ -23,8 +23,8 @@ type natsBroker struct {
|
||||
connected bool
|
||||
|
||||
addrs []string
|
||||
conn *natsp.Conn // single connection (used when pool is disabled)
|
||||
pool *connectionPool // connection pool (used when pooling is enabled)
|
||||
conn *natsp.Conn // single connection (used when pool is disabled)
|
||||
pool *connectionPool // connection pool (used when pooling is enabled)
|
||||
opts broker.Options
|
||||
nopts natsp.Options
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"testing"
|
||||
|
||||
natsp "github.com/nats-io/nats.go"
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v5/broker"
|
||||
)
|
||||
|
||||
var addrTestCases = []struct {
|
||||
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"time"
|
||||
|
||||
natsp "github.com/nats-io/nats.go"
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v5/broker"
|
||||
)
|
||||
|
||||
type optionsKey struct{}
|
||||
|
||||
+3
-3
@@ -4,9 +4,9 @@ import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
|
||||
"go-micro.dev/v6/codec"
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v5/codec"
|
||||
"go-micro.dev/v5/logger"
|
||||
"go-micro.dev/v5/registry"
|
||||
)
|
||||
|
||||
type Options struct {
|
||||
|
||||
@@ -11,8 +11,8 @@ import (
|
||||
"time"
|
||||
|
||||
amqp "github.com/rabbitmq/amqp091-go"
|
||||
mtls "go-micro.dev/v6/internal/util/tls"
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v5/logger"
|
||||
mtls "go-micro.dev/v5/util/tls"
|
||||
)
|
||||
|
||||
type MQExchangeType string
|
||||
|
||||
@@ -6,7 +6,7 @@ import (
|
||||
"testing"
|
||||
|
||||
amqp "github.com/rabbitmq/amqp091-go"
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v5/logger"
|
||||
)
|
||||
|
||||
func TestNewRabbitMQConnURL(t *testing.T) {
|
||||
|
||||
@@ -3,8 +3,8 @@ package rabbitmq
|
||||
import (
|
||||
"context"
|
||||
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/server"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/server"
|
||||
)
|
||||
|
||||
// setSubscribeOption returns a function to setup a context with given value.
|
||||
|
||||
@@ -4,9 +4,9 @@ import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v6/server"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/client"
|
||||
"go-micro.dev/v5/server"
|
||||
)
|
||||
|
||||
type durableQueueKey struct{}
|
||||
|
||||
@@ -10,8 +10,8 @@ import (
|
||||
"time"
|
||||
|
||||
amqp "github.com/rabbitmq/amqp091-go"
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/logger"
|
||||
)
|
||||
|
||||
type rbroker struct {
|
||||
|
||||
@@ -7,12 +7,12 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v5/logger"
|
||||
|
||||
micro "go-micro.dev/v6"
|
||||
broker "go-micro.dev/v6/broker"
|
||||
rabbitmq "go-micro.dev/v6/broker/rabbitmq"
|
||||
server "go-micro.dev/v6/server"
|
||||
micro "go-micro.dev/v5"
|
||||
broker "go-micro.dev/v5/broker"
|
||||
rabbitmq "go-micro.dev/v5/broker/rabbitmq"
|
||||
server "go-micro.dev/v5/server"
|
||||
)
|
||||
|
||||
type Example struct{}
|
||||
@@ -50,7 +50,8 @@ func TestDurable(t *testing.T) {
|
||||
|
||||
s := server.NewServer(server.Broker(b))
|
||||
|
||||
service := micro.NewService("test", micro.Server(s),
|
||||
service := micro.NewService(
|
||||
micro.Server(s),
|
||||
micro.Broker(b),
|
||||
)
|
||||
h := &Example{}
|
||||
@@ -81,7 +82,8 @@ func TestWithoutExchange(t *testing.T) {
|
||||
|
||||
s := server.NewServer(server.Broker(b))
|
||||
|
||||
service := micro.NewService("test", micro.Server(s),
|
||||
service := micro.NewService(
|
||||
micro.Server(s),
|
||||
micro.Broker(b),
|
||||
)
|
||||
brkrSub := broker.NewSubscribeOptions(
|
||||
@@ -138,7 +140,8 @@ func TestFanoutExchange(t *testing.T) {
|
||||
|
||||
s := server.NewServer(server.Broker(b))
|
||||
|
||||
service := micro.NewService("test", micro.Server(s),
|
||||
service := micro.NewService(
|
||||
micro.Server(s),
|
||||
micro.Broker(b),
|
||||
)
|
||||
brkrSub := broker.NewSubscribeOptions(
|
||||
@@ -195,7 +198,8 @@ func TestDirectExchange(t *testing.T) {
|
||||
|
||||
s := server.NewServer(server.Broker(b))
|
||||
|
||||
service := micro.NewService("test", micro.Server(s),
|
||||
service := micro.NewService(
|
||||
micro.Server(s),
|
||||
micro.Broker(b),
|
||||
)
|
||||
brkrSub := broker.NewSubscribeOptions(
|
||||
@@ -252,7 +256,8 @@ func TestTopicExchange(t *testing.T) {
|
||||
|
||||
s := server.NewServer(server.Broker(b))
|
||||
|
||||
service := micro.NewService("test", micro.Server(s),
|
||||
service := micro.NewService(
|
||||
micro.Server(s),
|
||||
micro.Broker(b),
|
||||
)
|
||||
brkrSub := broker.NewSubscribeOptions(
|
||||
|
||||
Vendored
+1
-1
@@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v5/logger"
|
||||
)
|
||||
|
||||
// Options represents the options for the cache.
|
||||
|
||||
Vendored
+1
-1
@@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
|
||||
rclient "github.com/go-redis/redis/v8"
|
||||
"go-micro.dev/v6/cache"
|
||||
"go-micro.dev/v5/cache"
|
||||
)
|
||||
|
||||
type redisOptionsContextKey struct{}
|
||||
|
||||
Vendored
+1
-1
@@ -6,7 +6,7 @@ import (
|
||||
"testing"
|
||||
|
||||
rclient "github.com/go-redis/redis/v8"
|
||||
"go-micro.dev/v6/cache"
|
||||
"go-micro.dev/v5/cache"
|
||||
)
|
||||
|
||||
func Test_newUniversalClient(t *testing.T) {
|
||||
|
||||
Vendored
+1
-1
@@ -5,7 +5,7 @@ import (
|
||||
"time"
|
||||
|
||||
rclient "github.com/go-redis/redis/v8"
|
||||
"go-micro.dev/v6/cache"
|
||||
"go-micro.dev/v5/cache"
|
||||
)
|
||||
|
||||
// NewRedisCache returns a new redis cache.
|
||||
|
||||
Vendored
+1
-1
@@ -6,7 +6,7 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/cache"
|
||||
"go-micro.dev/v5/cache"
|
||||
)
|
||||
|
||||
var (
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/internal/util/backoff"
|
||||
"go-micro.dev/v5/util/backoff"
|
||||
)
|
||||
|
||||
type BackoffFunc func(ctx context.Context, req Request, attempts int) (time.Duration, error)
|
||||
|
||||
+2
-2
@@ -9,8 +9,8 @@ import (
|
||||
|
||||
cache "github.com/patrickmn/go-cache"
|
||||
|
||||
"go-micro.dev/v6/metadata"
|
||||
"go-micro.dev/v6/transport/headers"
|
||||
"go-micro.dev/v5/metadata"
|
||||
"go-micro.dev/v5/transport/headers"
|
||||
)
|
||||
|
||||
// NewCache returns an initialized cache.
|
||||
|
||||
@@ -5,8 +5,8 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/metadata"
|
||||
"go-micro.dev/v6/transport/headers"
|
||||
"go-micro.dev/v5/metadata"
|
||||
"go-micro.dev/v5/transport/headers"
|
||||
)
|
||||
|
||||
func TestCache(t *testing.T) {
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ package client
|
||||
import (
|
||||
"context"
|
||||
|
||||
"go-micro.dev/v6/codec"
|
||||
"go-micro.dev/v5/codec"
|
||||
)
|
||||
|
||||
var (
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package client
|
||||
|
||||
import (
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v5/registry"
|
||||
)
|
||||
|
||||
var (
|
||||
|
||||
@@ -6,8 +6,8 @@ import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/codec"
|
||||
"go-micro.dev/v6/codec/bytes"
|
||||
"go-micro.dev/v5/codec"
|
||||
"go-micro.dev/v5/codec/bytes"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/encoding"
|
||||
"google.golang.org/protobuf/encoding/protojson"
|
||||
|
||||
@@ -3,7 +3,7 @@ package grpc
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"go-micro.dev/v6/errors"
|
||||
"go-micro.dev/v5/errors"
|
||||
"google.golang.org/grpc/codes"
|
||||
"google.golang.org/grpc/status"
|
||||
)
|
||||
|
||||
+9
-9
@@ -11,15 +11,15 @@ import (
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v6/cmd"
|
||||
raw "go-micro.dev/v6/codec/bytes"
|
||||
"go-micro.dev/v6/errors"
|
||||
"go-micro.dev/v6/metadata"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/selector"
|
||||
pnet "go-micro.dev/v6/internal/util/net"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/client"
|
||||
"go-micro.dev/v5/cmd"
|
||||
raw "go-micro.dev/v5/codec/bytes"
|
||||
"go-micro.dev/v5/errors"
|
||||
"go-micro.dev/v5/metadata"
|
||||
"go-micro.dev/v5/registry"
|
||||
"go-micro.dev/v5/selector"
|
||||
pnet "go-micro.dev/v5/util/net"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/credentials"
|
||||
"google.golang.org/grpc/encoding"
|
||||
|
||||
@@ -5,10 +5,10 @@ import (
|
||||
"net"
|
||||
"testing"
|
||||
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v6/errors"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/selector"
|
||||
"go-micro.dev/v5/client"
|
||||
"go-micro.dev/v5/errors"
|
||||
"go-micro.dev/v5/registry"
|
||||
"go-micro.dev/v5/selector"
|
||||
pgrpc "google.golang.org/grpc"
|
||||
pb "google.golang.org/grpc/examples/helloworld/helloworld"
|
||||
)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package grpc
|
||||
|
||||
import (
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v5/client"
|
||||
)
|
||||
|
||||
type grpcEvent struct {
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v5/client"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/encoding"
|
||||
)
|
||||
|
||||
@@ -4,8 +4,8 @@ import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v6/codec"
|
||||
"go-micro.dev/v5/client"
|
||||
"go-micro.dev/v5/codec"
|
||||
)
|
||||
|
||||
type grpcRequest struct {
|
||||
|
||||
@@ -3,8 +3,8 @@ package grpc
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"go-micro.dev/v6/codec"
|
||||
"go-micro.dev/v6/codec/bytes"
|
||||
"go-micro.dev/v5/codec"
|
||||
"go-micro.dev/v5/codec/bytes"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/encoding"
|
||||
)
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"io"
|
||||
"sync"
|
||||
|
||||
"go-micro.dev/v6/client"
|
||||
"go-micro.dev/v5/client"
|
||||
"google.golang.org/grpc"
|
||||
)
|
||||
|
||||
|
||||
+6
-12
@@ -4,12 +4,12 @@ import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/broker"
|
||||
"go-micro.dev/v6/codec"
|
||||
"go-micro.dev/v6/logger"
|
||||
"go-micro.dev/v6/registry"
|
||||
"go-micro.dev/v6/selector"
|
||||
"go-micro.dev/v6/transport"
|
||||
"go-micro.dev/v5/broker"
|
||||
"go-micro.dev/v5/codec"
|
||||
"go-micro.dev/v5/logger"
|
||||
"go-micro.dev/v5/registry"
|
||||
"go-micro.dev/v5/selector"
|
||||
"go-micro.dev/v5/transport"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -401,12 +401,6 @@ func WithMessageContentType(ct string) MessageOption {
|
||||
}
|
||||
}
|
||||
|
||||
func WithConnectionTimeout(d time.Duration) CallOption {
|
||||
return func(o *CallOptions) {
|
||||
o.ConnectionTimeout = d
|
||||
}
|
||||
}
|
||||
|
||||
// Request Options
|
||||
|
||||
func WithContentType(ct string) RequestOption {
|
||||
|
||||
@@ -4,7 +4,7 @@ import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go-micro.dev/v6/transport"
|
||||
"go-micro.dev/v5/transport"
|
||||
)
|
||||
|
||||
func TestCallOptions(t *testing.T) {
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user