@@ -123,7 +123,23 @@ with Orq(
123
123
api_key = os.getenv(" ORQ_API_KEY" , " " ),
124
124
) as orq:
125
125
126
- res = orq.contacts.create(external_id = " <id>" )
126
+ res = orq.contacts.create(request = {
127
+ " external_id" : " user_12345" ,
128
+ " display_name" : " Jane Smith" ,
129
+ " email" : " jane.smith@example.com" ,
130
+ " avatar_url" : " https://example.com/avatars/jane-smith.jpg" ,
131
+ " tags" : [
132
+ " premium" ,
133
+ " beta-user" ,
134
+ " enterprise" ,
135
+ ],
136
+ " metadata" : {
137
+ " department" : " Engineering" ,
138
+ " role" : " Senior Developer" ,
139
+ " subscription_tier" : " premium" ,
140
+ " last_login" : " 2024-01-15T10:30:00Z" ,
141
+ },
142
+ })
127
143
128
144
assert res is not None
129
145
@@ -146,7 +162,23 @@ async def main():
146
162
api_key = os.getenv(" ORQ_API_KEY" , " " ),
147
163
) as orq:
148
164
149
- res = await orq.contacts.create_async(external_id = " <id>" )
165
+ res = await orq.contacts.create_async(request = {
166
+ " external_id" : " user_12345" ,
167
+ " display_name" : " Jane Smith" ,
168
+ " email" : " jane.smith@example.com" ,
169
+ " avatar_url" : " https://example.com/avatars/jane-smith.jpg" ,
170
+ " tags" : [
171
+ " premium" ,
172
+ " beta-user" ,
173
+ " enterprise" ,
174
+ ],
175
+ " metadata" : {
176
+ " department" : " Engineering" ,
177
+ " role" : " Senior Developer" ,
178
+ " subscription_tier" : " premium" ,
179
+ " last_login" : " 2024-01-15T10:30:00Z" ,
180
+ },
181
+ })
150
182
151
183
assert res is not None
152
184
@@ -178,7 +210,23 @@ with Orq(
178
210
api_key = os.getenv(" ORQ_API_KEY" , " " ),
179
211
) as orq:
180
212
181
- res = orq.contacts.create(external_id = " <id>" )
213
+ res = orq.contacts.create(request = {
214
+ " external_id" : " user_12345" ,
215
+ " display_name" : " Jane Smith" ,
216
+ " email" : " jane.smith@example.com" ,
217
+ " avatar_url" : " https://example.com/avatars/jane-smith.jpg" ,
218
+ " tags" : [
219
+ " premium" ,
220
+ " beta-user" ,
221
+ " enterprise" ,
222
+ ],
223
+ " metadata" : {
224
+ " department" : " Engineering" ,
225
+ " role" : " Senior Developer" ,
226
+ " subscription_tier" : " premium" ,
227
+ " last_login" : " 2024-01-15T10:30:00Z" ,
228
+ },
229
+ })
182
230
183
231
assert res is not None
184
232
@@ -196,7 +244,11 @@ with Orq(
196
244
197
245
### [ contacts] ( docs/sdks/contacts/README.md )
198
246
199
- * [ create] ( docs/sdks/contacts/README.md#create ) - Update user information
247
+ * [ create] ( docs/sdks/contacts/README.md#create ) - Create a contact
248
+ * [ list] ( docs/sdks/contacts/README.md#list ) - List contacts
249
+ * [ retrieve] ( docs/sdks/contacts/README.md#retrieve ) - Retrieve a contact
250
+ * [ update] ( docs/sdks/contacts/README.md#update ) - Update a contact
251
+ * [ delete] ( docs/sdks/contacts/README.md#delete ) - Delete a contact
200
252
201
253
### [ datasets] ( docs/sdks/datasets/README.md )
202
254
@@ -211,7 +263,6 @@ with Orq(
211
263
* [ retrieve_datapoint] ( docs/sdks/datasets/README.md#retrieve_datapoint ) - Retrieve a datapoint
212
264
* [ update_datapoint] ( docs/sdks/datasets/README.md#update_datapoint ) - Update a datapoint
213
265
* [ delete_datapoint] ( docs/sdks/datasets/README.md#delete_datapoint ) - Delete a datapoint
214
- * [ create_datapoints] ( docs/sdks/datasets/README.md#create_datapoints ) - Create multiple datapoints
215
266
* [ clear] ( docs/sdks/datasets/README.md#clear ) - Delete all datapoints
216
267
217
268
### [ deployments] ( docs/sdks/deploymentssdk/README.md )
@@ -226,6 +277,48 @@ with Orq(
226
277
227
278
* [ create] ( docs/sdks/metrics/README.md#create ) - Add metrics
228
279
280
+ ### [ evals] ( docs/sdks/evals/README.md )
281
+
282
+ * [ all] ( docs/sdks/evals/README.md#all ) - Get all Evaluators
283
+ * [ create] ( docs/sdks/evals/README.md#create ) - Create an Evaluator
284
+ * [ update] ( docs/sdks/evals/README.md#update ) - Update an Evaluator
285
+ * [ delete] ( docs/sdks/evals/README.md#delete ) - Delete an Evaluator
286
+ * [ bert_score] ( docs/sdks/evals/README.md#bert_score ) - Run BertScore Evaluator
287
+ * [ bleu_score] ( docs/sdks/evals/README.md#bleu_score ) - Run BLEU Score Evaluator
288
+ * [ contains_all] ( docs/sdks/evals/README.md#contains_all ) - Run Contains All Evaluator
289
+ * [ contains_any] ( docs/sdks/evals/README.md#contains_any ) - Run Contains Any Evaluator
290
+ * [ contains_email] ( docs/sdks/evals/README.md#contains_email ) - Run Contains Email Evaluator
291
+ * [ contains_none] ( docs/sdks/evals/README.md#contains_none ) - Run Contains None Evaluator
292
+ * [ contains_url] ( docs/sdks/evals/README.md#contains_url ) - Run Contains URL Evaluator
293
+ * [ contains_valid_link] ( docs/sdks/evals/README.md#contains_valid_link ) - Run Contains Valid Link Evaluator
294
+ * [ contains] ( docs/sdks/evals/README.md#contains ) - Run Contains Evaluator
295
+ * [ ends_with] ( docs/sdks/evals/README.md#ends_with ) - Run Ends With Evaluator
296
+ * [ exact_match] ( docs/sdks/evals/README.md#exact_match ) - Run Exact Match Evaluator
297
+ * [ length_between] ( docs/sdks/evals/README.md#length_between ) - Run Length Between Evaluator
298
+ * [ length_greater_than] ( docs/sdks/evals/README.md#length_greater_than ) - Run Length Greater Than Evaluator
299
+ * [ length_less_than] ( docs/sdks/evals/README.md#length_less_than ) - Run Length Less Than Evaluator
300
+ * [ valid_json] ( docs/sdks/evals/README.md#valid_json ) - Run JSON Validation Evaluator
301
+ * [ age_appropriate] ( docs/sdks/evals/README.md#age_appropriate ) - Run Age Appropriate Evaluator
302
+ * [ bot_detection] ( docs/sdks/evals/README.md#bot_detection ) - Run Bot Detection Evaluator
303
+ * [ fact_checking_knowledge_base] ( docs/sdks/evals/README.md#fact_checking_knowledge_base ) - Run Fact Checking Knowledge Base Evaluator
304
+ * [ grammar] ( docs/sdks/evals/README.md#grammar ) - Run Grammar Evaluator
305
+ * [ localization] ( docs/sdks/evals/README.md#localization ) - Run Localization Evaluator
306
+ * [ pii] ( docs/sdks/evals/README.md#pii ) - Run PII Evaluator
307
+ * [ sentiment_classification] ( docs/sdks/evals/README.md#sentiment_classification ) - Run Sentiment Classification Evaluator
308
+ * [ summarization] ( docs/sdks/evals/README.md#summarization ) - Run Summarization Evaluator
309
+ * [ tone_of_voice] ( docs/sdks/evals/README.md#tone_of_voice ) - Run Tone of Voice Evaluator
310
+ * [ translation] ( docs/sdks/evals/README.md#translation ) - Run Translation Evaluator
311
+ * [ ragas_coherence] ( docs/sdks/evals/README.md#ragas_coherence ) - Run Coherence Evaluator
312
+ * [ ragas_conciseness] ( docs/sdks/evals/README.md#ragas_conciseness ) - Run Conciseness Evaluator
313
+ * [ ragas_context_precision] ( docs/sdks/evals/README.md#ragas_context_precision ) - Run Context Precision Evaluator
314
+ * [ ragas_correctness] ( docs/sdks/evals/README.md#ragas_correctness ) - Run Correctness Evaluator
315
+ * [ ragas_faithfulness] ( docs/sdks/evals/README.md#ragas_faithfulness ) - Run Faithfulness Evaluator
316
+ * [ ragas_harmfulness] ( docs/sdks/evals/README.md#ragas_harmfulness ) - Run Harmfulness Evaluator
317
+ * [ ragas_maliciousness] ( docs/sdks/evals/README.md#ragas_maliciousness ) - Run Maliciousness Evaluator
318
+ * [ ragas_response_relevancy] ( docs/sdks/evals/README.md#ragas_response_relevancy ) - Run Response Relevancy Evaluator
319
+ * [ ragas_summarization] ( docs/sdks/evals/README.md#ragas_summarization ) - Run Summarization Evaluator
320
+ * [ invoke] ( docs/sdks/evals/README.md#invoke ) - Invoke a Custom Evaluator
321
+
229
322
### [ feedback] ( docs/sdks/feedback/README.md )
230
323
231
324
* [ create] ( docs/sdks/feedback/README.md#create ) - Submit feedback
@@ -365,7 +458,23 @@ with Orq(
365
458
api_key = os.getenv(" ORQ_API_KEY" , " " ),
366
459
) as orq:
367
460
368
- res = orq.contacts.create(external_id = " <id>" ,
461
+ res = orq.contacts.create(request = {
462
+ " external_id" : " user_12345" ,
463
+ " display_name" : " Jane Smith" ,
464
+ " email" : " jane.smith@example.com" ,
465
+ " avatar_url" : " https://example.com/avatars/jane-smith.jpg" ,
466
+ " tags" : [
467
+ " premium" ,
468
+ " beta-user" ,
469
+ " enterprise" ,
470
+ ],
471
+ " metadata" : {
472
+ " department" : " Engineering" ,
473
+ " role" : " Senior Developer" ,
474
+ " subscription_tier" : " premium" ,
475
+ " last_login" : " 2024-01-15T10:30:00Z" ,
476
+ },
477
+ },
369
478
RetryConfig(" backoff" , BackoffStrategy(1 , 50 , 1.1 , 100 ), False ))
370
479
371
480
assert res is not None
@@ -387,7 +496,23 @@ with Orq(
387
496
api_key = os.getenv(" ORQ_API_KEY" , " " ),
388
497
) as orq:
389
498
390
- res = orq.contacts.create(external_id = " <id>" )
499
+ res = orq.contacts.create(request = {
500
+ " external_id" : " user_12345" ,
501
+ " display_name" : " Jane Smith" ,
502
+ " email" : " jane.smith@example.com" ,
503
+ " avatar_url" : " https://example.com/avatars/jane-smith.jpg" ,
504
+ " tags" : [
505
+ " premium" ,
506
+ " beta-user" ,
507
+ " enterprise" ,
508
+ ],
509
+ " metadata" : {
510
+ " department" : " Engineering" ,
511
+ " role" : " Senior Developer" ,
512
+ " subscription_tier" : " premium" ,
513
+ " last_login" : " 2024-01-15T10:30:00Z" ,
514
+ },
515
+ })
391
516
392
517
assert res is not None
393
518
@@ -411,12 +536,12 @@ By default, an API error will raise a models.APIError exception, which has the f
411
536
| ` .raw_response ` | * httpx.Response* | The raw HTTP response |
412
537
| ` .body ` | * str* | The response content |
413
538
414
- When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective * Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the ` list_async ` method may raise the following exceptions:
539
+ When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective * Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the ` retrieve_async ` method may raise the following exceptions:
415
540
416
- | Error Type | Status Code | Content Type |
417
- | ------------------- | ----------- | ---------------- |
418
- | models.HonoAPIError | 500 | application/json |
419
- | models.APIError | 4XX, 5XX | \* /\* |
541
+ | Error Type | Status Code | Content Type |
542
+ | ------------------------------------------ | ----------- | ---------------- |
543
+ | models.RetrieveContactContactsResponseBody | 404 | application/json |
544
+ | models.APIError | 4XX, 5XX | \* /\* |
420
545
421
546
### Example
422
547
@@ -431,15 +556,15 @@ with Orq(
431
556
res = None
432
557
try :
433
558
434
- res = orq.deployments.list( limit = 10 )
559
+ res = orq.contacts.retrieve( id = " <id> " )
435
560
436
561
assert res is not None
437
562
438
563
# Handle response
439
564
print (res)
440
565
441
- except models.HonoAPIError as e:
442
- # handle e.data: models.HonoAPIErrorData
566
+ except models.RetrieveContactContactsResponseBody as e:
567
+ # handle e.data: models.RetrieveContactContactsResponseBodyData
443
568
raise (e)
444
569
except models.APIError as e:
445
570
# handle exception
@@ -463,7 +588,23 @@ with Orq(
463
588
api_key = os.getenv(" ORQ_API_KEY" , " " ),
464
589
) as orq:
465
590
466
- res = orq.contacts.create(external_id = " <id>" )
591
+ res = orq.contacts.create(request = {
592
+ " external_id" : " user_12345" ,
593
+ " display_name" : " Jane Smith" ,
594
+ " email" : " jane.smith@example.com" ,
595
+ " avatar_url" : " https://example.com/avatars/jane-smith.jpg" ,
596
+ " tags" : [
597
+ " premium" ,
598
+ " beta-user" ,
599
+ " enterprise" ,
600
+ ],
601
+ " metadata" : {
602
+ " department" : " Engineering" ,
603
+ " role" : " Senior Developer" ,
604
+ " subscription_tier" : " premium" ,
605
+ " last_login" : " 2024-01-15T10:30:00Z" ,
606
+ },
607
+ })
467
608
468
609
assert res is not None
469
610
0 commit comments