model

type Candidate struct {
	// ID of the candidate entity.
	ID EntityID `json:"id"`

	// Name of the candidate entity.
	Name string `json:"name"`

	// Types of the candidate entity.
	Types []*Type `json:"type"`

	// Score indicates how good the match is. Higher is better.
	Score float64 `json:"score"`

	// Match indicates if this is a "good" match or not.
	Match bool `json:"match"`
}

type DatabaseSource struct {
	// contains filtered or unexported fields
}

type Entity struct {
	// ID is a unique identifier for the entity.
	ID EntityID `json:"id"`

	// Name is a human-readable description of the entity.
	Name string `json:"name"`

	// Description is a human-readable description of the entity.
	Description string `json:"description,omitempty"`

	// Properties is all the other properties of the Entity.
	Properties map[string]interface{} `json:"-"`

	// Types is a (possibly empty) list of entity types for this entity.
	Types []*Type `json:"type,omitempty"`
}

type EntityID string

type MemorySource struct {
	// contains filtered or unexported fields
}

type Property struct {
	// ID is a unique identifier for the property.
	ID string `json:"id"`

	// Name is a human-readable name of the property.
	Name string `json:"name"`

	// Description is a human-readable description of the property.
	Description string `json:"description,omitempty"`

	// ValueType expected for Property values.
	ValueType string `json:"-"`
}

type PropertyValue struct {
	// contains filtered or unexported fields
}

type QueryProperty struct {
	// ID is the property ID.
	ID string `json:"pid"`

	// Value is the text to search for in the Property.
	Value interface{} `json:"v"`
}

type QueryRequest struct {
	// ID to refer to the query.
	ID string `json:"id"`

	// Text is the search text to query for.
	Text string `json:"query"`

	// Type is the Type ID to query over (if present).
	Type string `json:"type"`

	// Limit the results to the first N results.
	Limit int `json:"limit"`

	// Properties lists the various property values to query over.
	Properties []*QueryProperty `json:"properties"`

	// Strictness should be set to "any", "all", or "should"
	Strictness string `json:"type_strict,omitempty"`
}

type QueryResponse struct {
	// ID of the QueryRequest this is responding to.
	ID string `json:"id"`

	// Results lists the Candidates matching the query.
	Results []*Candidate `json:"result"`
}

type Source interface {
	// Name of the data Source.
	Name() string

	// IdentifierNS is a universal namespace for Entity identifiers.
	IdentifierNS() string

	// SchemaNS is a universal namespace for concept Type identifiers.
	SchemaNS() string

	// ViewURL returns the template for a View URL.
	ViewURL() string

	// Types returns all supported Entity types.
	Types() []*Type

	// Properties returns all supported Properties for Entities with the Type ID given.
	Properties(typeID string) []*Property

	// GetEntity returns the Entity matching the provided ID.
	GetEntity(entityID EntityID) (*Entity, bool)

	// Query entitities for a match.
	Query(q *QueryRequest) (*QueryResponse, error)

	// QueryPrefix searches entitities for a prefix match.
	QueryPrefix(text string, limit int) []*Entity
}

type Type struct {
	// ID is a unique identifier for the type.
	ID string `json:"id"`

	// Name is a human-readable description of the type.
	Name string `json:"name"`

	// Description is a human-readable description of the type.
	Description string `json:"description,omitempty"`

	// ViewURL describes how to turn an Entity ID into a permalink.
	ViewURL string `json:"url"`
}