Collection

To get support by the Visual Studio Code extension, create a file with the name *.collection.yml or *.collection.yaml.

version: "0.1"
documents:
  - id: "doc-1"
    file: "path/to/document"
    metadata:
      name: "Document Name"
      link: "https://example.com"

Root Structure

The top-level YAML structure.

Property	Type	Required	Description
version	string	Yes	Fixed to "0.1".
documents	array<Document>	Yes	List of documents in the collection.

Document

The root configuration object for a document within the AMSL collection.

Property	Type	Required	Description
id	string	Yes	Unique identifier for the document (must be unique across all documents).
file	string	Yes	Path to the document file.
type	DocumentType	No	The document type (affects chunking strategy). Default: inferred from file.
metadata	DocumentMetadata	Yes	Metadata describing the document.
exclude	array<integer>	No	List of page numbers (0-indexed) to exclude. Default: [].

DocumentMetadata

Metadata associated with the document.

Property	Type	Required	Description
name	string	Yes	Display name of the document.
link	string	Yes	External link associated with the document.

DocumentType

String enum. Defines the document format and chunking strategy. Allowable values:

• "slides": Presentation slides (PDF or similar).
• "book": Book or long-form document.
• "paper": Academic or research paper.
• "text": Plain text or generic document.

Example

version: "0.1"
documents:
  - id: intro-slides
    file: slides/intro.pdf
    type: slides
    metadata:
      name: Introduction
      link: https://example.com/intro
    exclude: [0, 1]
  - id: reference-doc
    file: docs/reference.md
    type: text
    metadata:
      name: Reference Guide
      link: https://example.com/reference