Discovery Jobs
Package: github.com/emergent-company/emergent.memory/apps/server/pkg/sdk/discoveryjobs
Client field: client.DiscoveryJobs
Discovery Jobs perform AI-driven schema analysis on your documents to detect recurring object types and relationships. Once a job completes you can finalize the results into a new or existing Template Pack.
Methods
Section titled “Methods”StartDiscovery
Section titled “StartDiscovery”func (c *Client) StartDiscovery(ctx context.Context, req *StartDiscoveryRequest) (*StartDiscoveryResponse, error)Starts a new schema discovery job.
POST /api/discovery-jobs
| Parameter | Type | Description |
|---|---|---|
DocumentIDs |
[]string |
IDs of documents to analyse |
BatchSize |
int |
Documents processed per batch (optional) |
MinConfidence |
float32 |
Minimum confidence threshold 0–1 (optional) |
IncludeRelationships |
bool |
Also discover relationship types (optional) |
MaxIterations |
int |
Cap on LLM iterations (optional) |
Returns StartDiscoveryResponse with JobID.
ListJobs
Section titled “ListJobs”func (c *Client) ListJobs(ctx context.Context) ([]JobListItem, error)Lists all discovery jobs for the current project.
GET /api/discovery-jobs
GetJobStatus
Section titled “GetJobStatus”func (c *Client) GetJobStatus(ctx context.Context, jobID string) (*JobStatusResponse, error)Returns the current status and discovered types/relationships for a job.
GET /api/discovery-jobs/:id
CancelJob
Section titled “CancelJob”func (c *Client) CancelJob(ctx context.Context, jobID string) (*CancelJobResponse, error)Cancels a running discovery job.
POST /api/discovery-jobs/:id/cancel
FinalizeDiscovery
Section titled “FinalizeDiscovery”func (c *Client) FinalizeDiscovery(ctx context.Context, jobID string, req *FinalizeDiscoveryRequest) (*FinalizeDiscoveryResponse, error)Converts a completed job’s results into a template pack.
POST /api/discovery-jobs/:id/finalize
| Parameter | Type | Description |
|---|---|---|
PackName |
string |
Name for the new template pack |
Mode |
string |
"create" or "update" |
ExistingPackID |
*string |
Required when Mode is "update" |
IncludedTypes |
[]IncludedType |
Type definitions to include |
IncludedRelationships |
[]IncludedRelationship |
Relationship definitions to include (optional) |
Returns FinalizeDiscoveryResponse with TemplatePackID.
StartDiscoveryRequest
Section titled “StartDiscoveryRequest”type StartDiscoveryRequest struct { DocumentIDs []string `json:"document_ids"` BatchSize int `json:"batch_size,omitempty"` MinConfidence float32 `json:"min_confidence,omitempty"` // Optional. Omitted means true: discovery also proposes relationship // types. Send false explicitly to skip that phase. IncludeRelationships *bool `json:"include_relationships,omitempty"` MaxIterations int `json:"max_iterations,omitempty"`}StartDiscoveryResponse
Section titled “StartDiscoveryResponse”type StartDiscoveryResponse struct { JobID string `json:"job_id"`}JobStatusResponse
Section titled “JobStatusResponse”type JobStatusResponse struct { ID string `json:"id"` Status string `json:"status"` Progress JSONMap `json:"progress"` CreatedAt time.Time `json:"created_at"` StartedAt *time.Time `json:"started_at,omitempty"` CompletedAt *time.Time `json:"completed_at,omitempty"` ErrorMessage *string `json:"error_message,omitempty"` DiscoveredTypes JSONArray `json:"discovered_types"` DiscoveredRelationships JSONArray `json:"discovered_relationships"` TemplatePackID *string `json:"template_pack_id,omitempty"`}Status values: "pending", "running", "completed", "failed", "cancelled".
JobListItem
Section titled “JobListItem”type JobListItem struct { ID string `json:"id"` Status string `json:"status"` Progress JSONMap `json:"progress"` CreatedAt time.Time `json:"created_at"` CompletedAt *time.Time `json:"completed_at,omitempty"` DiscoveredTypes JSONArray `json:"discovered_types"` DiscoveredRelationships JSONArray `json:"discovered_relationships"` TemplatePackID *string `json:"template_pack_id,omitempty"`}FinalizeDiscoveryRequest / IncludedType / IncludedRelationship
Section titled “FinalizeDiscoveryRequest / IncludedType / IncludedRelationship”type FinalizeDiscoveryRequest struct { PackName string `json:"packName"` Mode string `json:"mode"` // "create" | "update" ExistingPackID *string `json:"existingPackId,omitempty"` IncludedTypes []IncludedType `json:"includedTypes"` IncludedRelationships []IncludedRelationship `json:"includedRelationships,omitempty"`}
type IncludedType struct { TypeName string `json:"type_name"` Description string `json:"description"` Properties map[string]any `json:"properties"` RequiredProperties []string `json:"required_properties"` ExampleInstances []any `json:"example_instances"` Frequency int `json:"frequency"`}
type IncludedRelationship struct { SourceType string `json:"source_type"` TargetType string `json:"target_type"` RelationType string `json:"relation_type"` Description string `json:"description"` Cardinality string `json:"cardinality"`}FinalizeDiscoveryResponse
Section titled “FinalizeDiscoveryResponse”type FinalizeDiscoveryResponse struct { TemplatePackID string `json:"template_pack_id"` Message string `json:"message"`}Example
Section titled “Example”// Start discovery on a set of documentsres, err := client.DiscoveryJobs.StartDiscovery(ctx, &discoveryjobs.StartDiscoveryRequest{ DocumentIDs: []string{"doc-1", "doc-2", "doc-3"}, IncludeRelationships: true, MinConfidence: 0.7,})if err != nil { log.Fatal(err)}jobID := res.JobID
// Poll until completefor { status, err := client.DiscoveryJobs.GetJobStatus(ctx, jobID) if err != nil { log.Fatal(err) } if status.Status == "completed" || status.Status == "failed" { break } time.Sleep(5 * time.Second)}
// Finalize into a new template packfinal, err := client.DiscoveryJobs.FinalizeDiscovery(ctx, jobID, &discoveryjobs.FinalizeDiscoveryRequest{ PackName: "my-schema-v1", Mode: "create", IncludedTypes: selectedTypes, // built from status.DiscoveredTypes})