@inferedge/moss-clustering v1.0.0-beta.3

---

@inferedge/moss-clustering / GenerateIndexDocumentClustersResponse

Interface: GenerateIndexDocumentClustersResponse

Response returned when clustering documents synchronously

Extends

• IndexDocumentClustersBase

Properties

indexName

indexName: string

Index name used for clustering

Inherited from

IndexDocumentClustersBase.indexName

---

k

k: number

Number of clusters generated

Inherited from

IndexDocumentClustersBase.k

---

documentsProcessed

documentsProcessed: number

Number of documents processed

Inherited from

IndexDocumentClustersBase.documentsProcessed

---

createdAt

createdAt: string

Timestamp when clustering was created

Inherited from

IndexDocumentClustersBase.createdAt

---

updatedAt?

optional updatedAt: string

Timestamp of the last update (if available)

Inherited from

IndexDocumentClustersBase.updatedAt

---

clusters

clusters: DocumentClusterInfo[]

Cluster definitions

Inherited from

IndexDocumentClustersBase.clusters

---

assignments

assignments: DocumentClusterAssignment[]

Document assignments

Inherited from

IndexDocumentClustersBase.assignments

---

progress

progress: DocumentClusteringProgress[]

Progress information for each phase of the job