Skip to content

Commit 9c483ca

Browse files
author
stlc-bot
committed
docs(people): note that complex ultra people searches can take up to 60 seconds (#2206)
Stainless-Generated-From: 2a32bddde7809f3d33143d2340e32390190b5c15
1 parent f9d3393 commit 9c483ca

3 files changed

Lines changed: 12 additions & 6 deletions

File tree

‎lib/context_dev/models/person_search_params.rb‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ class PersonSearchParams < ContextDev::Internal::Type::BaseModel
2929
# @!attribute mode
3030
# `fast` matches people on basic criteria (e.g. their role, location or
3131
# background); `ultra` plans a deeper search, judges each candidate against every
32-
# criterion in the query and explains each match.
32+
# criterion in the query. Complex `ultra` searches can take up to 60 seconds to
33+
# complete, so allow for that in your client timeout.
3334
#
3435
# @return [Symbol, ContextDev::Models::PersonSearchParams::Mode, nil]
3536
optional :mode, enum: -> { ContextDev::PersonSearchParams::Mode }
@@ -87,7 +88,8 @@ class Filters < ContextDev::Internal::Type::BaseModel
8788

8889
# `fast` matches people on basic criteria (e.g. their role, location or
8990
# background); `ultra` plans a deeper search, judges each candidate against every
90-
# criterion in the query and explains each match.
91+
# criterion in the query. Complex `ultra` searches can take up to 60 seconds to
92+
# complete, so allow for that in your client timeout.
9193
module Mode
9294
extend ContextDev::Internal::Type::Enum
9395

‎rbi/context_dev/models/person_search_params.rbi‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ module ContextDev
3434

3535
# `fast` matches people on basic criteria (e.g. their role, location or
3636
# background); `ultra` plans a deeper search, judges each candidate against every
37-
# criterion in the query and explains each match.
37+
# criterion in the query. Complex `ultra` searches can take up to 60 seconds to
38+
# complete, so allow for that in your client timeout.
3839
sig { returns(T.nilable(ContextDev::PersonSearchParams::Mode::OrSymbol)) }
3940
attr_reader :mode
4041

@@ -68,7 +69,8 @@ module ContextDev
6869
filters: nil,
6970
# `fast` matches people on basic criteria (e.g. their role, location or
7071
# background); `ultra` plans a deeper search, judges each candidate against every
71-
# criterion in the query and explains each match.
72+
# criterion in the query. Complex `ultra` searches can take up to 60 seconds to
73+
# complete, so allow for that in your client timeout.
7274
mode: nil,
7375
# Labels for filtering usage in the dashboard.
7476
tags: nil,
@@ -154,7 +156,8 @@ module ContextDev
154156

155157
# `fast` matches people on basic criteria (e.g. their role, location or
156158
# background); `ultra` plans a deeper search, judges each candidate against every
157-
# criterion in the query and explains each match.
159+
# criterion in the query. Complex `ultra` searches can take up to 60 seconds to
160+
# complete, so allow for that in your client timeout.
158161
module Mode
159162
extend ContextDev::Internal::Type::Enum
160163

‎rbi/context_dev/resources/people.rbi‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ module ContextDev
6868
filters: nil,
6969
# `fast` matches people on basic criteria (e.g. their role, location or
7070
# background); `ultra` plans a deeper search, judges each candidate against every
71-
# criterion in the query and explains each match.
71+
# criterion in the query. Complex `ultra` searches can take up to 60 seconds to
72+
# complete, so allow for that in your client timeout.
7273
mode: nil,
7374
# Labels for filtering usage in the dashboard.
7475
tags: nil,

0 commit comments

Comments
 (0)