Skip to content

Commit bb21d79

Browse files
docs: fix version numbers, add comprehensive examples, and fix support URLs (#46)
- Fix Maven and Gradle versions to 2.3.0 (consistent) - Add comprehensive examples section with snippets for all community features - Add enterprise feature snippets (code governance, cost controls, MCP policy) - Fix Support section with correct documentation, issues, and email links
1 parent 479d361 commit bb21d79

1 file changed

Lines changed: 91 additions & 10 deletions

File tree

README.md

Lines changed: 91 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Official Java SDK for [AxonFlow](https://getaxonflow.com) - AI Governance Platfo
1919
<dependency>
2020
<groupId>com.getaxonflow</groupId>
2121
<artifactId>axonflow-sdk</artifactId>
22-
<version>2.2.0</version>
22+
<version>2.3.0</version>
2323
</dependency>
2424
```
2525

2626
### Gradle
2727

2828
```groovy
29-
implementation 'com.getaxonflow:axonflow-sdk:3.0.0'
29+
implementation 'com.getaxonflow:axonflow-sdk:2.3.0'
3030
```
3131

3232
## Quick Start
@@ -414,11 +414,92 @@ See our [Spring Boot Integration Guide](https://docs.getaxonflow.com/sdks/java/s
414414

415415
## Examples
416416

417-
- [Hello World](examples/hello-world) - Basic usage
418-
- [Gateway Mode](examples/gateway-mode) - Pre-check and audit flow
419-
- [Proxy Mode](examples/proxy-mode) - Simple proxy integration
420-
- [Multi-Agent Planning](examples/map) - Orchestrated workflows
421-
- [Error Handling](examples/error-handling) - Exception handling patterns
417+
Complete working examples for all features are available in the [examples folder](https://github.com/getaxonflow/axonflow/tree/main/examples).
418+
419+
### Community Features
420+
421+
```java
422+
// PII Detection - Automatically detect sensitive data
423+
PolicyApproval result = client.getPolicyApprovedContext(
424+
ClientRequest.builder()
425+
.userPrompt("My SSN is 123-45-6789")
426+
.userId("user-123")
427+
.build()
428+
);
429+
// result.isAllowed() = true, result.requiresRedaction() = true (SSN detected)
430+
431+
// SQL Injection Detection - Block malicious queries
432+
PolicyApproval result = client.getPolicyApprovedContext(
433+
ClientRequest.builder()
434+
.userPrompt("SELECT * FROM users; DROP TABLE users;")
435+
.userId("user-123")
436+
.build()
437+
);
438+
// result.isAllowed() = false, result.getBlockedReason() = "SQL injection detected"
439+
440+
// Static Policies - List and manage built-in policies
441+
List<Policy> policies = client.listPolicies();
442+
// Returns: [Policy{name="pii-detection", enabled=true}, ...]
443+
444+
// Dynamic Policies - Create runtime policies
445+
client.createDynamicPolicy(DynamicPolicyRequest.builder()
446+
.name("block-competitor-queries")
447+
.conditions(Map.of("contains", List.of("competitor", "pricing")))
448+
.action("block")
449+
.build());
450+
451+
// MCP Connectors - Query external data sources
452+
MCPQueryResponse resp = client.queryConnector(MCPQueryRequest.builder()
453+
.connectorName("postgres-db")
454+
.operation("query")
455+
.parameters(Map.of("sql", "SELECT name FROM customers"))
456+
.build());
457+
458+
// Multi-Agent Planning - Orchestrate complex workflows
459+
PlanResponse plan = client.generatePlan(PlanRequest.builder()
460+
.goal("Research AI governance regulations")
461+
.domain("legal")
462+
.build());
463+
StepExecutionResponse result = client.executePlan(plan.getPlanId());
464+
465+
// Audit Logging - Track all LLM interactions
466+
client.auditLLMCall(AuditRequest.builder()
467+
.requestId(approval.getRequestId())
468+
.llmResponse(llmResponse)
469+
.model("gpt-4")
470+
.tokenUsage(TokenUsage.builder()
471+
.promptTokens(100)
472+
.completionTokens(200)
473+
.totalTokens(300)
474+
.build())
475+
.latencyMs(450)
476+
.build());
477+
```
478+
479+
### Enterprise Features
480+
481+
These features require an AxonFlow Enterprise license:
482+
483+
```java
484+
// Code Governance - Automated PR reviews with AI
485+
PRReviewResponse prResult = client.reviewPullRequest(PRReviewRequest.builder()
486+
.repoOwner("your-org")
487+
.repoName("your-repo")
488+
.prNumber(123)
489+
.checkTypes(List.of("security", "style", "performance"))
490+
.build());
491+
492+
// Cost Controls - Budget management for LLM usage
493+
Budget budget = client.getBudget("team-engineering");
494+
// Returns: Budget{limit=1000.00, used=234.56, remaining=765.44}
495+
496+
// MCP Policy Enforcement - Automatic PII redaction in connector responses
497+
MCPQueryResponse resp = client.queryConnector(query);
498+
// resp.getPolicyInfo().isRedacted() = true
499+
// resp.getPolicyInfo().getRedactedFields() = ["ssn", "credit_card"]
500+
```
501+
502+
For enterprise features, contact [sales@getaxonflow.com](mailto:sales@getaxonflow.com).
422503

423504
## Contributing
424505

@@ -430,6 +511,6 @@ This SDK is licensed under the [Apache License 2.0](LICENSE).
430511

431512
## Support
432513

433-
- [Documentation](https://docs.getaxonflow.com)
434-
- [GitHub Issues](https://github.com/getaxonflow/axonflow-sdk-java/issues)
435-
- [Community Discord](https://discord.gg/axonflow)
514+
- **Documentation**: https://docs.getaxonflow.com
515+
- **Issues**: https://github.com/getaxonflow/axonflow-sdk-java/issues
516+
- **Email**: dev@getaxonflow.com

0 commit comments

Comments
 (0)