KnowledgeDocumentTabularInspectionRead

Stateless inspection result for one CSV, XLS, or XLSX file.

source_typeKnowledgeDocumentSourceTyperequired

Detected CSV, XLS, or XLSX source type.

Possible values: [text, markdown, csv, xls, pdf, xlsx]

sheets object[]

Inspectable sheets without persisting or uploading the source file.

Array [

indexIndexrequired

Zero-based sheet index used by tabular ingestion configuration.

Possible values: >= 0

nameNamerequired

Worksheet name, or CSV for a CSV source.

row_countRow Countrequired

Number of non-empty data rows excluding the header row.

Possible values: >= 0

columns object[]

Columns detected from the header and any trailing data cells.

Array [

indexIndexrequired

Zero-based column index used by tabular ingestion configuration.

Possible values: >= 0

nameNamerequired

Header label shown to the user. Blank headers receive a generated label.

]

preview_rowsarray[]

A small sample of normalized data rows excluding the header.

]

default_config objectrequired

Ready-to-submit configuration enabling the first sheet with data and selecting all columns.

sheets object[]required

Configuration for every sheet returned by inspection.

Possible values: >= 1

Array [

sheet_indexSheet Indexrequired

Zero-based sheet index returned by inspection.

Possible values: >= 0

sheet_nameSheet Namerequired

Sheet name returned by inspection.

Possible values: non-empty

enabledEnabled

Whether this sheet should produce retrievable row units.

Default value: true

search_column_indexesinteger[]

Zero-based columns used for lexical matching and embeddings.

retrieval_column_indexesinteger[]

Zero-based columns returned to the chatbot when a row is retrieved.

]

KnowledgeDocumentTabularInspectionRead

{
  "source_type": "text",
  "sheets": [
    {
      "index": 0,
      "name": "string",
      "row_count": 0,
      "columns": [
        {
          "index": 0,
          "name": "string"
        }
      ],
      "preview_rows": [
        "string"
      ]
    }
  ],
  "default_config": {
    "sheets": [
      {
        "sheet_index": 0,
        "sheet_name": "string",
        "enabled": true,
        "search_column_indexes": [
          0
        ],
        "retrieval_column_indexes": [
          0
        ]
      }
    ]
  }
}