recruit/client-search-conversation · ClientSearchConversation
Client search conversation
A search's conversation for the person it is run for: each turn, each version of the brief under the turn that wrote it, and a composer for words and files.
Install
With your coding agent
Install RecruiterOS/recruit-ui and add a conversation that gets a client's brief ready, with each version of the brief in it.With the shadcn CLI
pnpm dlx shadcn@latest add RecruiterOS/recruit-ui/recruit-workflowsProps
| Prop | Type | What it does |
|---|---|---|
| threadrequired | readonly ClientSearchConversationItem[] | The conversation in order, as `clientSearchThread` returns it: each turn, each version of the brief under the turn that wrote it, each delivery where it landed. |
| agentNamerequired | string | Who runs the search: names their turns, and a delivery's run ("How Scout searched"). |
| awaitingReply | boolean | A reply to the reader is being written: the thread ends on a running line (`labels.reading`) and the composer is held. |
| suggestedReplies | readonly string[] | Replies offered next, such as answers to the latest question: one tap sends one. |
| onReply | (words: string, files: File[]) => unknown | Sends the reader's reply: their words, and the files they attached to it (none for a suggested reply). While a promise it returns is pending the composer is held under a running line (`labels.sending`). When it resolves, the files it sent leave the composer. When it rejects, the words go back in the composer, the files stay, and `labels.failed` shows under it. Without it nothing can be written. |
| maxFiles | number | How many files one reply takes: 5 by default, and 0 leaves files out. Picking more keeps the first and says so (`labels.tooManyFiles`). |
| readOnly | boolean | Shows the conversation and takes nothing: no composer, no suggested replies, no Yes or No. |
| onDecide | (person: ClientSearchPerson, decision: CandidateDecisionChoice, reason: string) => Promise<void> | Saves a Yes or No on a person in a delivery, as `ClientSearchDelivery` takes it. |
| reasonOptional | boolean | Lets an answer on a person be saved with no reason. |
| reasonSuggestions | { yes?: readonly string[]; no?: readonly string[]; } | One-tap reasons for each answer on a person, already worded. |
| briefOptions | Omit<JobBriefViewOptions, "current"> | How each version of the brief is read, as `jobBriefView` takes it. |
| markdownComponents | MarkdownComponents | Per-element overrides for the turns' Markdown, and a run's. |
| chat | ClientSearchChatProps | The kit Chat's own props, passed straight through. |
| labels | Partial<ClientSearchLabels> | |
| decisionLabels | Partial<CandidateClientDecisionLabels> | The Yes or No row's wording, as `CandidateClientDecision` takes it. |
| traceLabels | Partial<SourcingTraceLabels> | A run's wording, as `SourcingTrace` takes it. |
Data
The component takes plain values and callbacks and keeps no records of its own. Pass it yours, from the Kith data layer or from a backend you already run.