Class AiMatchMakingClient

Client for the AI Matchmaking service. This service allows you to create matchmakers and insert entities into them. The service will then find matches for the entities.

Index

Methods

createMatchMaker getMatchMaker listMatchMakers

Methods

createMatchMaker

createMatchMaker(matchMaker: MmMatchMaker): Promise<MatchMaker>
Creates a new matchmaker with the given metadata.
Parameters
- matchMaker: MmMatchMaker
  Object describing the matchmaker including ID, description (used as AI instructions), and categories.
Returns Promise<MatchMaker>
A MatchMaker instance to perform entity-level operations.

getMatchMaker

getMatchMaker(matchMakerId: string): Promise<undefined | MatchMaker>
Retrieves an existing matchmaker by its ID.
Parameters
- matchMakerId: string
  ID of the matchmaker to retrieve.
Returns Promise<undefined | MatchMaker>
A MatchMaker instance if found, otherwise undefined.

listMatchMakers

listMatchMakers(): Promise<MmMatchMaker[]>
Lists all existing matchmakers.

Returns Promise<MmMatchMaker[]>