model

type Channel struct {
	// ID uniquely identifies the channel.
	ID ID
	// Name is the channel name without any leading symbol.
	Name string
	// Topic is the channel's stated topic, shown to users.
	Topic string
	// Members lists the people active in the channel, by person ID.
	Members []ID
	// Topics maps a topic ID to the channel's affinity weight for it.
	Topics map[ID]float64
}

type ChannelMatch struct {
	// Channel is the matched channel.
	Channel *Channel
	// Score is the relevance score; higher is more relevant.
	Score float64
	// Confidence estimates how trustworthy the match is, from zero to one:
	// query-term coverage scaled by the strength of the matched fields.
	Confidence float64
	// Reasons explains why the channel matched.
	Reasons []string
	// TopMembers are the most relevant active members, most relevant first.
	TopMembers []*Person
}

type Graph struct {
	// People maps person ID to person.
	People map[ID]*Person `json:"people"`
	// Teams maps team ID to team.
	Teams map[ID]*Team `json:"teams"`
	// Orgs maps org ID to organization.
	Orgs map[ID]*Org `json:"orgs"`
	// Topics maps topic ID to topic.
	Topics map[ID]*Topic `json:"topics"`
	// Channels maps channel ID to channel.
	Channels map[ID]*Channel `json:"channels"`
}

type ID string

type Match struct {
	// Person is the matched individual.
	Person *Person
	// Team is the matched person's team, if known.
	Team *Team
	// Score is the relevance score; higher is more relevant.
	Score float64
	// Confidence estimates how trustworthy the match is, from zero to one:
	// query-term coverage scaled by the strength of the matched fields.
	Confidence float64
	// Reasons explains why the person matched, for transparency.
	Reasons []string
}

type Org struct {
	// ID uniquely identifies the organization.
	ID ID
	// Name is the organization's display name.
	Name string
}

type Person struct {
	// ID uniquely identifies the person.
	ID ID
	// Name is the person's display name.
	Name string
	// Email is the person's work email address.
	Email string
	// Title is the person's job title.
	Title string
	// TeamID links the person to their team.
	TeamID ID
	// OrgID links the person to their organization.
	OrgID ID
	// ManagerID links the person to their manager, if known.
	ManagerID ID
	// Identities lists alternate identifiers merged into this person, such as
	// a GitHub login joined to an email.
	Identities []ID
	// Topics maps a topic ID to this person's affinity weight for it.
	Topics map[ID]float64
}

type Team struct {
	// ID uniquely identifies the team.
	ID ID
	// Name is the team's display name.
	Name string
	// OrgID links the team to its organization.
	OrgID ID
	// Desc is an optional description of the team's remit.
	Desc string
}

type Topic struct {
	// ID uniquely identifies the topic.
	ID ID
	// Name is the normalized topic text.
	Name string
}