@bluefly/openstandardagents 0.2.4 → 0.2.5-RC

package/openapi/reference-implementations/document-analyzer-api.openapi.yaml

@@ -0,0 +1,217 @@
+openapi: 3.1.0
+info:
+  title: Document Analyzer Agent API
+  version: 2.1.0
+  description: |
+    Production document analysis agent with NLP capabilities.
+    Analyzes documents for sentiment, extracts entities, generates summaries, and classifies content.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: intermediate
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: document-analyzer
+    type: worker
+    compliance:
+      standards:
+        - openapi-first
+        - type-safe
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: https://document-analyzer.platform.com/api/v1
+    description: Production
+
+tags:
+  - name: analysis
+    description: Document analysis operations
+  - name: extraction
+    description: Text extraction operations
+
+paths:
+  /analyze:
+    post:
+      summary: Analyze document
+      description: Comprehensive document analysis with sentiment and entity extraction
+      operationId: analyzeDocument
+      tags: [analysis]
+      x-ossa-capability: analyze_document
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-4o-mini
+        temperature: 0.3
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [document]
+              properties:
+                document:
+                  type: string
+                  description: Document text to analyze
+                include_entities:
+                  type: boolean
+                  default: true
+                include_sentiment:
+                  type: boolean
+                  default: true
+      responses:
+        '200':
+          description: Analysis completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  sentiment:
+                    type: object
+                    properties:
+                      score:
+                        type: number
+                      label:
+                        type: string
+                      confidence:
+                        type: number
+                  entities:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        type:
+                          type: string
+                        text:
+                          type: string
+                        start:
+                          type: integer
+                        end:
+                          type: integer
+                  summary:
+                    type: string
+
+  /extract:
+    post:
+      summary: Extract text from document
+      description: Extract text from various document formats (PDF, DOCX, images)
+      operationId: extractText
+      tags: [extraction]
+      x-ossa-capability: extract_text
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required: [document]
+              properties:
+                document:
+                  type: string
+                  format: binary
+                  description: Document file to extract text from
+      responses:
+        '200':
+          description: Text extracted
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  text:
+                    type: string
+                  metadata:
+                    type: object
+                    properties:
+                      format:
+                        type: string
+                      pages:
+                        type: integer
+
+  /summarize:
+    post:
+      summary: Summarize document
+      description: Generate concise document summary
+      operationId: summarizeDocument
+      tags: [analysis]
+      x-ossa-capability: summarize_document
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [text]
+              properties:
+                text:
+                  type: string
+                  description: Document text to summarize
+                max_length:
+                  type: integer
+                  default: 500
+                  description: Maximum summary length in characters
+      responses:
+        '200':
+          description: Summary generated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  summary:
+                    type: string
+                  length:
+                    type: integer
+
+  /classify:
+    post:
+      summary: Classify document
+      description: Classify document into predefined categories
+      operationId: classifyDocument
+      tags: [analysis]
+      x-ossa-capability: classify_document
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [text]
+              properties:
+                text:
+                  type: string
+                  description: Document text to classify
+      responses:
+        '200':
+          description: Classification completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  category:
+                    type: string
+                  confidence:
+                    type: number
+                    minimum: 0
+                    maximum: 1
+

package/openapi/reference-implementations/getting-started-hello-world-api.openapi.yaml

@@ -0,0 +1,149 @@
+openapi: 3.1.0
+info:
+  title: Hello World Agent API
+  version: 1.0.0
+  description: |
+    Minimal OSSA-compliant agent API demonstrating basic capabilities.
+    This agent can greet users, echo messages, and report its status.
+    Perfect for learning OSSA fundamentals and testing deployments.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: basic
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: hello-world-agent
+    type: worker
+    compliance:
+      standards:
+        - openapi-first
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: http://localhost:3000
+    description: Local development server
+
+tags:
+  - name: greeting
+    description: Greeting operations
+  - name: echo
+    description: Echo operations
+  - name: status
+    description: Status operations
+
+paths:
+  /greet:
+    post:
+      summary: Generate greeting
+      description: Generates a personalized greeting message for a user
+      operationId: greet
+      tags: [greeting]
+      x-ossa-capability: greeting
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-3.5-turbo
+        temperature: 0.7
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [name]
+              properties:
+                name:
+                  type: string
+                  description: Name to greet
+                  example: "Alice"
+                language:
+                  type: string
+                  enum: [en, es, fr, de]
+                  default: en
+                  description: Language for greeting
+      responses:
+        '200':
+          description: Greeting generated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: The greeting message
+                  timestamp:
+                    type: string
+                    format: date-time
+
+  /echo:
+    post:
+      summary: Echo input
+      description: Echo back a message sent to the agent
+      operationId: echo
+      tags: [echo]
+      x-ossa-capability: echo_message
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [message]
+              properties:
+                message:
+                  type: string
+                  description: Message to echo
+      responses:
+        '200':
+          description: Message echoed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  echo:
+                    type: string
+                  received_at:
+                    type: string
+                    format: date-time
+
+  /status:
+    get:
+      summary: Get agent status
+      description: Returns the current status of the agent
+      operationId: getStatus
+      tags: [status]
+      x-ossa-capability: get_status
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      responses:
+        '200':
+          description: Agent status
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                    enum: [online, offline, maintenance]
+                  version:
+                    type: string
+                  uptime:
+                    type: integer
+                    description: Uptime in seconds
+

package/openapi/reference-implementations/gitlab-ml-recommender-api.openapi.yaml

@@ -0,0 +1,151 @@
+openapi: 3.1.0
+info:
+  title: GitLab ML Recommendation Engine API
+  version: 1.0.0
+  description: |
+    AI-powered customer success recommendation agent using RAG (Retrieval-Augmented Generation).
+    Provides data-driven recommendations for proactive customer engagement.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: intermediate
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: gitlab-ml-recommender
+    type: integration
+    compliance:
+      standards:
+        - openapi-first
+        - type-safe
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: https://ml-recommender.platform.com/api/v1
+    description: Production
+
+tags:
+  - name: recommendations
+    description: Recommendation operations
+  - name: search
+    description: Semantic search operations
+
+paths:
+  /recommendations/generate:
+    post:
+      summary: Generate recommendations
+      description: |
+        Generate AI-powered recommendations using RAG pipeline.
+        Performs semantic search in Qdrant and generates recommendations with GPT-4.
+      operationId: generateRecommendations
+      tags: [recommendations]
+      x-ossa-capability: generate-recommendations
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      x-ossa-llm:
+        provider: openai
+        model: gpt-4
+        temperature: 0.7
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [customer_id]
+              properties:
+                customer_id:
+                  type: string
+                  description: Customer identifier
+                context:
+                  type: object
+                  description: Additional context for recommendations
+                limit:
+                  type: integer
+                  default: 10
+                  description: Maximum number of recommendations
+      responses:
+        '200':
+          description: Recommendations generated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  recommendations:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                        title:
+                          type: string
+                        description:
+                          type: string
+                        priority:
+                          type: string
+                        confidence:
+                          type: number
+                        source:
+                          type: string
+                  customer_health_score:
+                    type: number
+
+  /search/semantic:
+    post:
+      summary: Semantic search
+      description: Perform semantic search in Qdrant vector database
+      operationId: semanticSearch
+      tags: [search]
+      x-ossa-capability: semantic-search
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [query]
+              properties:
+                query:
+                  type: string
+                  description: Search query text
+                top_k:
+                  type: integer
+                  default: 5
+                  description: Number of results to return
+                filters:
+                  type: object
+                  description: Additional filters for search
+      responses:
+        '200':
+          description: Search results
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  results:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                        text:
+                          type: string
+                        score:
+                          type: number
+                        metadata:
+                          type: object
+

package/openapi/reference-implementations/governor-agent-api.openapi.yaml

@@ -0,0 +1,193 @@
+openapi: 3.1.0
+info:
+  title: Policy Compliance Governor Agent API
+  version: 1.1.0
+  description: |
+    Governance agent enforcing policies, compliance, and security standards across systems.
+    Validates compliance, assesses risks, and generates audit reports.
+
+x-ossa-metadata:
+  version: 0.2.5-RC
+  compliance:
+    level: enterprise
+    frameworks:
+      - OSSA
+      - OpenAPI 3.1
+      - SOC2
+      - PCI-DSS
+      - GDPR
+      - HIPAA
+      - ISO27001
+  governance:
+    approved: true
+    approvedBy: Governance Team
+    approvalDate: "2024-01-15"
+
+x-ossa:
+  version: 0.2.5-RC
+  agent:
+    id: policy-compliance-governor
+    type: governor
+    compliance:
+      standards:
+        - openapi-first
+        - type-safe
+      validated: true
+      validatedAt: "2024-01-15T10:00:00Z"
+
+servers:
+  - url: https://governor.platform.com/api/v1
+    description: Production
+
+tags:
+  - name: policies
+    description: Policy enforcement operations
+  - name: compliance
+    description: Compliance validation operations
+  - name: audit
+    description: Audit operations
+
+paths:
+  /policies/enforce:
+    post:
+      summary: Enforce policy
+      description: Enforce policy on a resource or action
+      operationId: enforcePolicy
+      tags: [policies]
+      x-ossa-capability: enforce-policies
+      x-ossa-autonomy:
+        level: supervised
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [policy, resource]
+              properties:
+                policy:
+                  type: string
+                  description: Policy identifier
+                resource:
+                  type: object
+                  description: Resource to enforce policy on
+                mode:
+                  type: string
+                  enum: [advisory, blocking, logging]
+                  default: blocking
+      responses:
+        '200':
+          description: Policy enforced
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  allowed:
+                    type: boolean
+                  reason:
+                    type: string
+                  violations:
+                    type: array
+                    items:
+                      type: object
+
+  /compliance/validate:
+    post:
+      summary: Validate compliance
+      description: Validate resource or system against compliance framework
+      operationId: validateCompliance
+      tags: [compliance]
+      x-ossa-capability: validate-compliance
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [framework, resource]
+              properties:
+                framework:
+                  type: string
+                  enum: [soc2, pci-dss, gdpr, hipaa, iso27001]
+                resource:
+                  type: object
+                controls:
+                  type: array
+                  items:
+                    type: string
+      responses:
+        '200':
+          description: Compliance validation completed
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  compliant:
+                    type: boolean
+                  violations:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        control:
+                          type: string
+                        severity:
+                          type: string
+                        description:
+                          type: string
+                  score:
+                    type: number
+
+  /audit/generate:
+    post:
+      summary: Generate audit report
+      description: Generate audit report for compliance tracking
+      operationId: generateAuditReport
+      tags: [audit]
+      x-ossa-capability: generate-reports
+      x-ossa-autonomy:
+        level: autonomous
+        approval_required: false
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [period]
+              properties:
+                period:
+                  type: object
+                  properties:
+                    start:
+                      type: string
+                      format: date-time
+                    end:
+                      type: string
+                      format: date-time
+                format:
+                  type: string
+                  enum: [json, pdf, html]
+                  default: json
+      responses:
+        '200':
+          description: Audit report generated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  report_id:
+                    type: string
+                  report_url:
+                    type: string
+                    format: uri
+                  summary:
+                    type: object
+