SourceSchema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SourceSchema",
  "title": "SourceSchema",
  "properties": {
    "name": {
      "type": "string",
      "title": "Name",
      "description": "The name of the source."
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description",
      "description": "The description of the source."
    },
    "instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Instructions",
      "description": "Instructions for how to use the source."
    },
    "metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Metadata",
      "description": "Metadata associated with the source."
    },
    "embedding": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Embedding",
      "description": "The handle for the embedding config used by the source."
    },
    "embedding_chunk_size": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Embedding Chunk Size",
      "description": "The chunk size of the embedding."
    },
    "embedding_config": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/EmbeddingConfig"
        },
        {
          "type": "null"
        }
      ],
      "description": "(Legacy) The embedding configuration used by the source."
    },
    "id": {
      "type": "string",
      "title": "Id",
      "description": "Human-readable identifier for this source in the file"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "name",
    "id"
  ],
  "description": "Source with human-readable ID for agent file"
}