Zum Inhalt
HALOWERK

Agentenwerk

intent clarify

Takes a list of candidate intents, each described by attributes, plus whatever is already known, and returns the one attribute worth asking about next. Candidates contradicted by the known values are ruled out first and listed with the attribute that excluded them; a candidate that simply does not declare a known attribute is kept, because silence is not a contradiction.

POST https://agent.halowerk.com/v1/intent-clarify

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
candidatesarrayJaThe competing intents, two to fifty.
knownobjectNeinAttribute values already established, for example from earlier answers.
ask_aboutarrayNeinRestrict the question to these attributes. Empty or absent means all of them.
max_optionsintegerNeinHow many answer options the question may offer. Excess values are named under omitted_values, never dropped silently.
attribute_promptsobjectNeinYour own question wording per attribute. Used verbatim where given.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "candidates"
  ],
  "additionalProperties": false,
  "properties": {
    "candidates": {
      "type": "array",
      "minItems": 2,
      "maxItems": 50,
      "description": "The competing intents, two to fifty.",
      "items": {
        "type": "object",
        "required": [
          "id",
          "attributes"
        ],
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "description": "Identifier, unique within the call."
          },
          "label": {
            "type": "string",
            "maxLength": 300,
            "description": "Optional human-readable name, echoed unchanged."
          },
          "attributes": {
            "type": "object",
            "description": "What distinguishes this candidate. Values must be scalar.",
            "additionalProperties": {
              "type": [
                "string",
                "number",
                "boolean",
                "null"
              ]
            }
          },
          "prior": {
            "type": "number",
            "minimum": 0,
            "maximum": 1000,
            "default": 1,
            "description": "Relative likelihood of this candidate before asking. Used to weight the expected outcome."
          }
        }
      }
    },
    "known": {
      "type": "object",
      "description": "Attribute values already established, for example from earlier answers.",
      "additionalProperties": {
        "type": [
          "string",
          "number",
          "boolean",
          "null"
        ]
      }
    },
    "ask_about": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128
      },
      "description": "Restrict the question to these attributes. Empty or absent means all of them."
    },
    "max_options": {
      "type": "integer",
      "minimum": 2,
      "maximum": 10,
      "default": 5,
      "description": "How many answer options the question may offer. Excess values are named under omitted_values, never dropped silently."
    },
    "attribute_prompts": {
      "type": "object",
      "description": "Your own question wording per attribute. Used verbatim where given.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 300
      }
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "candidates": [
    {
      "id": "book_flight",
      "label": "Book a flight",
      "attributes": {
        "object": "travel",
        "action": "book",
        "urgency": "high"
      },
      "prior": 3
    },
    {
      "id": "book_hotel",
      "label": "Book a hotel room",
      "attributes": {
        "object": "lodging",
        "action": "book",
        "urgency": "high"
      },
      "prior": 2
    },
    {
      "id": "cancel_flight",
      "label": "Cancel a flight",
      "attributes": {
        "object": "travel",
        "action": "cancel",
        "urgency": "high"
      },
      "prior": 1
    },
    {
      "id": "flight_status",
      "label": "Check flight status",
      "attributes": {
        "object": "travel",
        "action": "inspect",
        "urgency": "low"
      },
      "prior": 4
    }
  ],
  "known": {
    "urgency": "high"
  },
  "max_options": 5,
  "attribute_prompts": {
    "action": "What would you like to do?"
  }
}

Ergebnis & Dokumentation

Veröffentlichtes Ergebnisschema anzeigen
{
  "$ref": "https://agent.halowerk.com/v1/intent-clarify/schema#/outputSchema"
}

Veröffentlichtes Ergebnisbeispiel öffnen

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →