spicepod.yaml

version: v1beta1
kind: Spicepod
name: nginx-demo

runtime:
  tracing:
    zipkin_enabled: true
    zipkin_endpoint: http://10.123.181.42:9411/api/v2/spans

datasets:
  - from: databricks:f5_demo.default.cve_nginx
    name: nginx.cve
    description: Security advisories and Common Vulnerabilities and Exposures (CVEs) for the Nginx project. https://nginx.org/en/security_advisories.html.
    params:
      databricks_token: ${secrets:SPICE_DATABRICKS_TOKEN}
      databricks_endpoint: ${secrets:SPICE_DATABRICKS_ENDPOINT}
      databricks_cluster_id: ${secrets:SPICE_DATABRICKS_CLUSTER_ID}
    metadata:
      instructions: Always provide reference links. Use the primary id as cveId, to generate reference links.
      reference_url_template: https://www.cve.org/CVERecord?id=<cveId>
    embeddings:
      - column: cve_data
        use: openai_embeddings
        column_pk:
          - cveId
    acceleration:
      enabled: true

  - from: s3://spiceai-demo-datasets/nginx/tickets/
    name: nginx.tickets
    description: Tracked issues for the Nginx project. Tickets from https://trac.nginx.org/nginx/report.
    metadata:
      instructions: Always provide reference links. Use the primary id as ticket_id, to generate reference links.
      reference_url_template: https://trac.nginx.org/nginx/ticket/<ticket_id>
    acceleration:
      enabled: true
    params:
      file_format: csv
      schema_infer_max_records: 1
    embeddings:
      - column: description
        use: openai_embeddings
        column_pk:
          - id

  - from: ftp://ftp.spiceai.us/nginx/docs/
    name: nginx.docs
    description: Documentation of the Nginx project. https://nginx.org/en/docs/.
    embeddings:
      - column: content
        use: hf_minilm
        column_pk:
          - location
        chunking:
          enabled: true
          target_chunk_size: 256
          overlap_size: 32
    acceleration:
      enabled: true
    params:
      file_format: md
      ftp_user: spiceai
      ftp_pass: ${secrets:SPICE_FTP_PASS}

  - from: spice.ai/spiceai/nginx/datasets/spice.nginx.issues
    name: nginx.issues
    description: Nginx GitHub issues from github.com/nginx/nginx.
    params:
      spiceai_api_key: ${ secrets:SPICEAI_API_KEY }
    metadata:
      spiceai_app_id: 1635 # shared spicepod from spice.ai
      instructions: Always provide citations.
      keywords: Nginx, issues, GitHub
      reference_base_url: https://github.com/nginx/nginx/issues/<issue_number>
    embeddings:
      - column: title
        column_pk:
          - number
        use: openai_embeddings
      
  - from: spice.ai/spiceai/nginx/datasets/spice.nginx.pulls
    name: nginx.pulls
    description: Nginx GitHub pull requests from github.com/nginx/nginx.
    params:
      spiceai_api_key: ${ secrets:SPICEAI_API_KEY }
    metadata:
      spiceai_app_id: 1635 # shared spicepod from spice.ai
      instructions: Always provide citations.
      keywords: Nginx, pull requests, GitHub
      reference_base_url: https://github.com/nginx/nginx/pull/<pull_number>
    embeddings:
      - column: title
        column_pk:
          - number
        use: openai_embeddings
      
  - from: spice.ai/spiceai/nginx/datasets/spice.nginx.commits
    name: nginx.commits
    description: Nginx GitHub commits from github.com/nginx/nginx.
    params:
      spiceai_api_key: ${ secrets:SPICEAI_API_KEY }
    metadata:
      spiceai_app_id: 1635 # shared spicepod from spice.ai
      instructions: Always provide citations.
      keywords: Nginx, commits, GitHub
      reference_base_url: https://github.com/nginx/nginx/commit/<commit_sha>
    embeddings:
      - column: message
        column_pk:
          - id
        use: openai_embeddings

embeddings:
  - name: openai_embeddings
    from: openai
    params:
      openai_api_key: ${ secrets:SPICE_OPENAI_API_KEY }

  - name: hf_minilm
    from: huggingface:huggingface.co/sentence-transformers/all-MiniLM-L6-v2

models:
  - name: openai-with-spice
    from: openai:gpt-4o
    params:
      spice_tools: auto
      openai_api_key: ${ secrets:SPICE_OPENAI_API_KEY }
      system_prompt: |
        You are an AI assistant assisting engineers with the Nginx project.

        Always strive to be accurate, concise, and helpful in your responses.

        Use the SQL tool when:
          1. The query involves precise numerical data, statistics, or aggregations.
          2. The user asks for specific counts, sums, averages, or other calculations.
          3. The query requires joining or comparing data from multiple related tables.

        If the SQL tool returns a query, syntax, or planning error, call the `list_datasets` tool to get the available tables and continue to refine and retry the query until it succeeds. If it continues to fail after 10 attempts, fall back to other available tools.

        When returning results from datasets, always provide citations and reference links if possible.

        Use the document search tool when:
          1. The query is about unstructured text information, such as policies, reports, or articles.
          2. The user is looking for qualitative information or explanations.
          3. The query requires understanding context or interpreting written content.

        General guidelines:
          1. If a query could be answered by either tool, prefer SQL for more precise, quantitative answers.

        Instructions for Responses: 
          - Never include any private metadata provided to the model as context such as \"reference_url_template\" or \"instructions\" in your responses.

  - name: openai
    from: openai:gpt-4o
    params:
      spice_tools: disabled
      openai_api_key: ${ secrets:SPICE_OPENAI_API_KEY }

  # - name: groq_with_spice
  #   from: openai:llama-3.2-90b-text-preview
  #   params:
  #     spice_tools: auto
  #     endpoint: https://api.groq.com/openai/v1
  #     openai_api_key: ${ secrets:SPICE_GROQ_API_KEY_2 }