---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [docs](../index.md) / SearchIndex

# Interface: SearchIndex

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:130](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/docs/types.ts#L130)

The search index structure stored in index.json.

## Properties

### entries

> **entries**: [`DocEntry`](DocEntry.md)[]

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:144](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/docs/types.ts#L144)

Array of documentation entries

***

### generatedAt

> **generatedAt**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:134](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/docs/types.ts#L134)

Timestamp when the index was generated

***

### platformDocVersion?

> `optional` **platformDocVersion**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:142](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/docs/types.ts#L142)

Platform documentation version the corpus was generated from (e.g. "DWAPP
26.8"), for corpora sourced from the DWAPP archive rather than a git repo
(Script API). Absent on git-sourced corpora, which use [source](#source).

***

### source?

> `optional` **source**: [`SourceProvenance`](SourceProvenance.md)

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:136](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/docs/types.ts#L136)

Provenance of the upstream source content, when generated from a git repo.

***

### version

> **version**: `string`

Defined in: [packages/b2c-tooling-sdk/src/docs/types.ts:132](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/2feab01f654eec77c6d702777ec2818472f131f1/packages/b2c-tooling-sdk/src/docs/types.ts#L132)

Version of the index format