Skip to content

Commit 4e6ce7f

Browse files
author
stlc-bot
committed
docs(people): note that complex ultra people searches can take up to 60 seconds (#2206)
Stainless-Generated-From: 953f3ff34aa60ea20a1310a056867cbe05305e9c
1 parent b7e350b commit 4e6ce7f

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

‎src/context/dev/resources/people.py‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ def search(
149149
150150
mode: `fast` matches people on basic criteria (e.g. their role, location or
151151
background); `ultra` plans a deeper search, judges each candidate against every
152-
criterion in the query and explains each match.
152+
criterion in the query. Complex `ultra` searches can take up to 60 seconds to
153+
complete, so allow for that in your client timeout.
153154
154155
tags: Labels for filtering usage in the dashboard.
155156
@@ -304,7 +305,8 @@ async def search(
304305
305306
mode: `fast` matches people on basic criteria (e.g. their role, location or
306307
background); `ultra` plans a deeper search, judges each candidate against every
307-
criterion in the query and explains each match.
308+
criterion in the query. Complex `ultra` searches can take up to 60 seconds to
309+
complete, so allow for that in your client timeout.
308310
309311
tags: Labels for filtering usage in the dashboard.
310312

‎src/context/dev/types/person_search_params.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ class PersonSearchParams(TypedDict, total=False):
2626
"""`fast` matches people on basic criteria (e.g.
2727
2828
their role, location or background); `ultra` plans a deeper search, judges each
29-
candidate against every criterion in the query and explains each match.
29+
candidate against every criterion in the query. Complex `ultra` searches can
30+
take up to 60 seconds to complete, so allow for that in your client timeout.
3031
"""
3132

3233
tags: SequenceNotStr[str]

0 commit comments

Comments
 (0)