FoodHouseholdChatContext food.household-chat-context@1

Generated at from openvibe-contracts v0.193.1 and openvibe-sdk v0.48.0.

Version
1.0.0
Owner
food
Visibility
internal
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/food/household-chat-context.v1.json

food.household-chat-context@1: what food.household.read answers (GET /internal/households/:planId/chat-context): a household's pantry and plan as plain text for the AI member of its OpenVibe.Chat room, and where it comes from.

Fields

FieldTypeRequiredDescriptionConstraints
textstringyesThe household's members, the plan (days, people, budget, meals), what is still to buy and what is in their cupboards.
  • maxLength 4000
sourcestringyesA label for the prompt, e.g. 'OpenVibe.Food household'.
  • maxLength 80
updated_atstring
  • format date-time

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: household
{
  "text": "Household: Kim, Lee.\nPlan \"This week\": 2 people, 7 days, budget 80 USD.\nStill to buy: lentils, onions.\nKim's cupboard: rice, canned tomatoes.\nLee's cupboard: eggs (a dozen).",
  "source": "OpenVibe.Food household",
  "updated_at": "2026-10-15T17:00:00.000Z"
}
Rejected: extra-field
{
  "text": "Household: Kim, Lee.",
  "source": "OpenVibe.Food household",
  "pantry_items": [
    "rice"
  ]
}
Rejected: no-source
{
  "text": "Household: Kim, Lee."
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('food.household-chat-context@1', value);   // { valid, errors: [{ path, message }] }