Tools Reference

ask_obi

Ask natural language questions about your property using OBI's RAG-powered AI assistant.

ask_obi

Ask questions about your property using OBI's AI assistant. Get answers about inventory, maintenance, documents, and more.

Use Cases

  • "What appliances do I have in the kitchen?"
  • "When was the HVAC last serviced?"
  • "What's the total value of electronics in my home?"
  • "Do I have any items under warranty?"
  • "What maintenance tasks are coming up?"

Parameters

ParameterTypeRequiredDescription
property_idstringYesUUID of the property to ask about
questionstringYesYour question (1-2000 characters)

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "ask_obi",
    "arguments": {
      "property_id": "550e8400-e29b-41d4-a716-446655440000",
      "question": "What appliances do I have in the kitchen?"
    }
  }
}

Example Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"answer\":\"Based on your inventory, you have the following appliances in the kitchen:\\n\\n1. **KitchenAid Stand Mixer** (Artisan 5-quart, Empire Red)\\n2. **Samsung French Door Refrigerator** (Model RF28R7551SR)\\n3. **Breville Espresso Machine** (Barista Express)\\n4. **Vitamix Blender** (Professional Series 750)\\n5. **Wolf Gas Range** (36-inch, 6 burners)\\n\\nTotal estimated value: $8,450\",\"sources\":[{\"type\":\"items\",\"name\":\"Home Inventory\"}],\"follow_up_questions\":[\"What's the warranty status on these appliances?\",\"When was the refrigerator purchased?\",\"Are there any appliances that need maintenance?\"]}"
      }
    ]
  }
}

Parsed Response

{
  "answer": "Based on your inventory, you have the following appliances in the kitchen:\n\n1. **KitchenAid Stand Mixer** (Artisan 5-quart, Empire Red)\n2. **Samsung French Door Refrigerator** (Model RF28R7551SR)\n3. **Breville Espresso Machine** (Barista Express)\n4. **Vitamix Blender** (Professional Series 750)\n5. **Wolf Gas Range** (36-inch, 6 burners)\n\nTotal estimated value: $8,450",
  "sources": [
    {
      "type": "items",
      "name": "Home Inventory"
    }
  ],
  "follow_up_questions": [
    "What's the warranty status on these appliances?",
    "When was the refrigerator purchased?",
    "Are there any appliances that need maintenance?"
  ]
}

Response Fields

FieldTypeDescription
answerstringAI-generated answer to your question
sourcesarrayData sources used to generate the answer
sources[].typestringSource type (property, location, weather, maintenance, providers, items)
sources[].namestringHuman-readable source name
follow_up_questionsarraySuggested follow-up questions

Context Sources

OBI's AI has access to comprehensive property context:

SourceDescription
PropertyAddress, type, size, systems, features
LocationGeographic and neighborhood information
WeatherCurrent conditions and seasonal context
MaintenanceTasks, history, schedules
ProvidersService providers and contacts
ItemsComplete home inventory and equipment

The sources field in the response indicates which context was used to answer your question.

Example Questions

Inventory Questions

  • "List all electronics in the living room"
  • "What's the most valuable item in my home?"
  • "Do I have any Samsung products?"
  • "Show me items purchased in 2023"

Maintenance Questions

  • "When was the roof last inspected?"
  • "What maintenance is due this month?"
  • "Who is my HVAC service provider?"
  • "What's the filter size for my furnace?"

Property Questions

  • "How many square feet is my home?"
  • "What year was the house built?"
  • "What type of heating system do I have?"
  • "When does my home warranty expire?"

Insurance Questions

  • "What's the total value of my inventory?"
  • "List high-value items over $1,000"
  • "Generate an inventory summary by room"

Error Handling

Question Too Long

{
  "content": [
    {
      "type": "text",
      "text": "{\"error\": \"Question exceeds maximum length of 2000 characters\"}"
    }
  ],
  "isError": true
}

Property Access Denied

{
  "content": [
    {
      "type": "text",
      "text": "{\"error\": \"Property not found or access denied\"}"
    }
  ],
  "isError": true
}

AI Service Error

{
  "content": [
    {
      "type": "text",
      "text": "{\"error\": \"Failed to create chat\"}"
    }
  ],
  "isError": true
}

Tips

  • Be specific - "What Samsung TVs do I have?" works better than "Tell me about my TVs"
  • Ask one thing at a time - Complex multi-part questions may get partial answers
  • Use follow-ups - The suggested questions help you dig deeper
  • Check sources - The sources field shows what data informed the answer