Skip to content

KnowledgeIntentInput

All wire models

Model aliases: KnowledgeIntentInput.

Type: object.

Fields

Required means the key must be present. Nullable means its value may be null; it does not make a required key optional. “Not specified” means the schema declares no default.

Field Type Required Default
action string Yes Not specified
destination_id string Yes Not specified
target_item_id string or null No null
expected_version integer or null No null
content KnowledgeContent Yes Not specified
include_remembered_context boolean No false
origin UserStatementOrigin or ConversationOrigin or ExternalProposalOrigin Yes Not specified

Model constraints

  • Additional properties: permitted

Field constraints

action

  • Allowed values: "create_draft", "create_published", "update_draft", "update_published", "publish_draft"

destination_id

  • Minimum length: 1
  • Maximum length: 64

target_item_id

  • anyOf branch 1 (string): Minimum length: 1
  • anyOf branch 1 (string): Maximum length: 64

expected_version

  • anyOf branch 1 (integer): Minimum: 1

origin

Exact JSON Schema

This is a schema definition, not an example request. It preserves all declared keywords, including constraints not summarized above.

Complete JSON Schema
JSON
{
  "additionalProperties": true,
  "properties": {
    "action": {
      "enum": [
        "create_draft",
        "create_published",
        "update_draft",
        "update_published",
        "publish_draft"
      ],
      "title": "Action",
      "type": "string"
    },
    "destination_id": {
      "maxLength": 64,
      "minLength": 1,
      "title": "Destination Id",
      "type": "string"
    },
    "target_item_id": {
      "anyOf": [
        {
          "maxLength": 64,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Target Item Id"
    },
    "expected_version": {
      "anyOf": [
        {
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Expected Version"
    },
    "content": {
      "$ref": "#/$defs/KnowledgeContent"
    },
    "include_remembered_context": {
      "default": false,
      "title": "Include Remembered Context",
      "type": "boolean"
    },
    "origin": {
      "discriminator": {
        "mapping": {
          "conversation": "#/$defs/ConversationOrigin",
          "external_proposal": "#/$defs/ExternalProposalOrigin",
          "user_statement": "#/$defs/UserStatementOrigin"
        },
        "propertyName": "kind"
      },
      "oneOf": [
        {
          "$ref": "#/$defs/UserStatementOrigin"
        },
        {
          "$ref": "#/$defs/ConversationOrigin"
        },
        {
          "$ref": "#/$defs/ExternalProposalOrigin"
        }
      ],
      "title": "Origin"
    }
  },
  "required": [
    "action",
    "destination_id",
    "content",
    "origin"
  ],
  "title": "KnowledgeIntentInput",
  "type": "object"
}