@orq-ai/node 3.9.14 → 3.9.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/mcp-server.js +124 -114
- package/bin/mcp-server.js.map +35 -35
- package/examples/README.md +5 -0
- package/examples/contactsCreate.example.ts +2 -0
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/server.js +1 -1
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/createeval.js +16 -16
- package/models/operations/createprompt.d.ts +6 -0
- package/models/operations/createprompt.d.ts.map +1 -1
- package/models/operations/createprompt.js +2 -0
- package/models/operations/createprompt.js.map +1 -1
- package/models/operations/deploymentinvoke.d.ts +3 -0
- package/models/operations/deploymentinvoke.d.ts.map +1 -1
- package/models/operations/deploymentinvoke.js +1 -0
- package/models/operations/deploymentinvoke.js.map +1 -1
- package/models/operations/deployments.d.ts +3 -0
- package/models/operations/deployments.d.ts.map +1 -1
- package/models/operations/deployments.js +1 -0
- package/models/operations/deployments.js.map +1 -1
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/getallprompts.d.ts +3 -0
- package/models/operations/getallprompts.d.ts.map +1 -1
- package/models/operations/getallprompts.js +1 -0
- package/models/operations/getallprompts.js.map +1 -1
- package/models/operations/getevals.js +28 -28
- package/models/operations/getoneprompt.d.ts +3 -0
- package/models/operations/getoneprompt.d.ts.map +1 -1
- package/models/operations/getoneprompt.js +1 -0
- package/models/operations/getoneprompt.js.map +1 -1
- package/models/operations/getpromptversion.d.ts +3 -0
- package/models/operations/getpromptversion.d.ts.map +1 -1
- package/models/operations/getpromptversion.js +1 -0
- package/models/operations/getpromptversion.js.map +1 -1
- package/models/operations/listcontacts.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/listpromptversions.d.ts +3 -0
- package/models/operations/listpromptversions.d.ts.map +1 -1
- package/models/operations/listpromptversions.js +1 -0
- package/models/operations/listpromptversions.js.map +1 -1
- package/models/operations/retrievecontact.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatecontact.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/models/operations/updateeval.js +16 -16
- package/models/operations/updateprompt.d.ts +6 -0
- package/models/operations/updateprompt.d.ts.map +1 -1
- package/models/operations/updateprompt.js +2 -0
- package/models/operations/updateprompt.js.map +1 -1
- package/package.json +1 -1
- package/packages/orq-rc/README.md +93 -91
- package/packages/orq-rc/docs/sdks/{knowledgebases → chunking}/README.md +10 -10
- package/packages/orq-rc/docs/sdks/knowledge/README.md +77 -0
- package/packages/orq-rc/examples/README.md +5 -0
- package/packages/orq-rc/examples/contactsCreate.example.ts +2 -0
- package/packages/orq-rc/examples/package-lock.json +1 -1
- package/packages/orq-rc/jsr.json +1 -1
- package/packages/orq-rc/package-lock.json +2 -2
- package/packages/orq-rc/package.json +1 -1
- package/packages/orq-rc/src/funcs/{knowledgeBasesChunkText.ts → chunkingParse.ts} +11 -11
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +158 -0
- package/packages/orq-rc/src/lib/config.ts +3 -3
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +1 -1
- package/packages/orq-rc/src/mcp-server/server.ts +5 -3
- package/packages/orq-rc/src/mcp-server/tools/{knowledgeBasesChunkText.ts → chunkingParse.ts} +6 -6
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +35 -0
- package/packages/orq-rc/src/models/operations/createcontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +2 -2
- package/packages/orq-rc/src/models/operations/createdatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/createeval.ts +16 -16
- package/packages/orq-rc/src/models/operations/createknowledge.ts +846 -0
- package/packages/orq-rc/src/models/operations/createprompt.ts +4 -0
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +2 -0
- package/packages/orq-rc/src/models/operations/deployments.ts +2 -0
- package/packages/orq-rc/src/models/operations/fileget.ts +2 -2
- package/packages/orq-rc/src/models/operations/filelist.ts +2 -2
- package/packages/orq-rc/src/models/operations/fileupload.ts +2 -2
- package/packages/orq-rc/src/models/operations/getallprompts.ts +2 -0
- package/packages/orq-rc/src/models/operations/getevals.ts +28 -28
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +2 -0
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +2 -0
- package/packages/orq-rc/src/models/operations/index.ts +2 -1
- package/packages/orq-rc/src/models/operations/listcontacts.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasets.ts +2 -2
- package/packages/orq-rc/src/models/operations/listdatasources.ts +2 -2
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +2 -0
- package/packages/orq-rc/src/models/operations/{chunktext.ts → parse.ts} +164 -183
- package/packages/orq-rc/src/models/operations/retrievecontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatecontact.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedataset.ts +2 -2
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +2 -2
- package/packages/orq-rc/src/models/operations/updateeval.ts +16 -16
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +266 -206
- package/packages/orq-rc/src/models/operations/updateprompt.ts +4 -0
- package/packages/orq-rc/src/sdk/{knowledgebases.ts → chunking.ts} +7 -7
- package/packages/orq-rc/src/sdk/knowledge.ts +15 -0
- package/packages/orq-rc/src/sdk/sdk.ts +4 -4
- package/src/lib/config.ts +3 -3
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/createeval.ts +16 -16
- package/src/models/operations/createprompt.ts +2 -0
- package/src/models/operations/deploymentinvoke.ts +1 -0
- package/src/models/operations/deployments.ts +1 -0
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/getallprompts.ts +1 -0
- package/src/models/operations/getevals.ts +28 -28
- package/src/models/operations/getoneprompt.ts +1 -0
- package/src/models/operations/getpromptversion.ts +1 -0
- package/src/models/operations/listcontacts.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/listpromptversions.ts +1 -0
- package/src/models/operations/retrievecontact.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatecontact.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/src/models/operations/updateeval.ts +16 -16
- package/src/models/operations/updateprompt.ts +2 -0
|
@@ -259,6 +259,10 @@ run();
|
|
|
259
259
|
<details open>
|
|
260
260
|
<summary>Available methods</summary>
|
|
261
261
|
|
|
262
|
+
### [chunking](docs/sdks/chunking/README.md)
|
|
263
|
+
|
|
264
|
+
* [parse](docs/sdks/chunking/README.md#parse) - Parse text
|
|
265
|
+
|
|
262
266
|
### [contacts](docs/sdks/contacts/README.md)
|
|
263
267
|
|
|
264
268
|
* [create](docs/sdks/contacts/README.md#create) - Create a contact
|
|
@@ -351,6 +355,7 @@ run();
|
|
|
351
355
|
### [knowledge](docs/sdks/knowledge/README.md)
|
|
352
356
|
|
|
353
357
|
* [list](docs/sdks/knowledge/README.md#list) - List all knowledge bases
|
|
358
|
+
* [create](docs/sdks/knowledge/README.md#create) - Create a knowledge
|
|
354
359
|
* [retrieve](docs/sdks/knowledge/README.md#retrieve) - Retrieves a knowledge base
|
|
355
360
|
* [update](docs/sdks/knowledge/README.md#update) - Updates a knowledge
|
|
356
361
|
* [delete](docs/sdks/knowledge/README.md#delete) - Deletes a knowledge
|
|
@@ -366,10 +371,6 @@ run();
|
|
|
366
371
|
* [deleteChunk](docs/sdks/knowledge/README.md#deletechunk) - Delete a chunk
|
|
367
372
|
* [retrieveChunk](docs/sdks/knowledge/README.md#retrievechunk) - Retrieve a chunk
|
|
368
373
|
|
|
369
|
-
### [knowledgeBases](docs/sdks/knowledgebases/README.md)
|
|
370
|
-
|
|
371
|
-
* [chunkText](docs/sdks/knowledgebases/README.md#chunktext) - Chunk text
|
|
372
|
-
|
|
373
374
|
### [models](docs/sdks/models/README.md)
|
|
374
375
|
|
|
375
376
|
* [list](docs/sdks/models/README.md#list) - List models
|
|
@@ -407,6 +408,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
407
408
|
|
|
408
409
|
<summary>Available standalone functions</summary>
|
|
409
410
|
|
|
411
|
+
- [`chunkingParse`](docs/sdks/chunking/README.md#parse) - Parse text
|
|
410
412
|
- [`contactsCreate`](docs/sdks/contacts/README.md#create) - Create a contact
|
|
411
413
|
- [`contactsDelete`](docs/sdks/contacts/README.md#delete) - Delete a contact
|
|
412
414
|
- [`contactsList`](docs/sdks/contacts/README.md#list) - List contacts
|
|
@@ -475,7 +477,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
475
477
|
- [`filesDelete`](docs/sdks/files/README.md#delete) - Delete file
|
|
476
478
|
- [`filesGet`](docs/sdks/files/README.md#get) - Retrieve a file
|
|
477
479
|
- [`filesList`](docs/sdks/files/README.md#list) - List all files
|
|
478
|
-
- [`
|
|
480
|
+
- [`knowledgeCreate`](docs/sdks/knowledge/README.md#create) - Create a knowledge
|
|
479
481
|
- [`knowledgeCreateChunks`](docs/sdks/knowledge/README.md#createchunks) - Create chunks for a datasource
|
|
480
482
|
- [`knowledgeCreateDatasource`](docs/sdks/knowledge/README.md#createdatasource) - Create a new datasource
|
|
481
483
|
- [`knowledgeDelete`](docs/sdks/knowledge/README.md#delete) - Deletes a knowledge
|
|
@@ -738,92 +740,92 @@ run();
|
|
|
738
740
|
|
|
739
741
|
|
|
740
742
|
**Inherit from [`OrqError`](./src/models/errors/orqerror.ts)**:
|
|
741
|
-
* [`HonoApiError`](./src/models/errors/honoapierror.ts): Applicable to 6 of
|
|
742
|
-
* [`RetrieveContactResponseBody`](./src/models/errors/retrievecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of
|
|
743
|
-
* [`UpdateContactResponseBody`](./src/models/errors/updatecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of
|
|
744
|
-
* [`DeleteContactResponseBody`](./src/models/errors/deletecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of
|
|
745
|
-
* [`UpdatePromptResponseBody`](./src/models/errors/updatepromptresponsebody.ts): Prompt not found. Status code `404`. Applicable to 1 of
|
|
746
|
-
* [`GetPromptVersionResponseBody`](./src/models/errors/getpromptversionresponsebody.ts): Not Found - The prompt or prompt version does not exist. Status code `404`. Applicable to 1 of
|
|
747
|
-
* [`GetEvalsResponseBody`](./src/models/errors/getevalsresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
748
|
-
* [`CreateEvalResponseBody`](./src/models/errors/createevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
749
|
-
* [`UpdateEvalResponseBody`](./src/models/errors/updateevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
750
|
-
* [`DeleteEvalResponseBody`](./src/models/errors/deleteevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
751
|
-
* [`EvalsBertScoreResponseBody`](./src/models/errors/evalsbertscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
752
|
-
* [`EvalsBleuScoreResponseBody`](./src/models/errors/evalsbleuscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
753
|
-
* [`EvalsContainsAllResponseBody`](./src/models/errors/evalscontainsallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
754
|
-
* [`EvalsContainsAnyResponseBody`](./src/models/errors/evalscontainsanyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
755
|
-
* [`EvalsContainsEmailResponseBody`](./src/models/errors/evalscontainsemailresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
756
|
-
* [`EvalsContainsNoneResponseBody`](./src/models/errors/evalscontainsnoneresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
757
|
-
* [`EvalsContainsUrlResponseBody`](./src/models/errors/evalscontainsurlresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
758
|
-
* [`EvalsContainsValidLinkResponseBody`](./src/models/errors/evalscontainsvalidlinkresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
759
|
-
* [`EvalsContainsResponseBody`](./src/models/errors/evalscontainsresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
760
|
-
* [`EvalsEndsWithResponseBody`](./src/models/errors/evalsendswithresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
761
|
-
* [`EvalsExactMatchResponseBody`](./src/models/errors/evalsexactmatchresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
762
|
-
* [`EvalsLengthBetweenResponseBody`](./src/models/errors/evalslengthbetweenresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
763
|
-
* [`EvalsLengthGreaterThanResponseBody`](./src/models/errors/evalslengthgreaterthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
764
|
-
* [`EvalsLengthLessThanResponseBody`](./src/models/errors/evalslengthlessthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
765
|
-
* [`EvalsValidJsonResponseBody`](./src/models/errors/evalsvalidjsonresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
766
|
-
* [`EvalsAgeAppropriateResponseBody`](./src/models/errors/evalsageappropriateresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
767
|
-
* [`EvalsBotDetectionResponseBody`](./src/models/errors/evalsbotdetectionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
768
|
-
* [`EvalsFactCheckingKnowledgeBaseResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
769
|
-
* [`EvalsGrammarResponseBody`](./src/models/errors/evalsgrammarresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
770
|
-
* [`EvalsLocalizationResponseBody`](./src/models/errors/evalslocalizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
771
|
-
* [`EvalsPiiResponseBody`](./src/models/errors/evalspiiresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
772
|
-
* [`EvalsSentimentClassificationResponseBody`](./src/models/errors/evalssentimentclassificationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
773
|
-
* [`EvalsSummarizationResponseBody`](./src/models/errors/evalssummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
774
|
-
* [`EvalsToneOfVoiceResponseBody`](./src/models/errors/evalstoneofvoiceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
775
|
-
* [`EvalsTranslationResponseBody`](./src/models/errors/evalstranslationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
776
|
-
* [`EvalsRagasCoherenceResponseBody`](./src/models/errors/evalsragascoherenceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
777
|
-
* [`EvalsRagasConcisenessResponseBody`](./src/models/errors/evalsragasconcisenessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
778
|
-
* [`EvalsRagasContextPrecisionResponseBody`](./src/models/errors/evalsragascontextprecisionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
779
|
-
* [`EvalsRagasContextRecallResponseBody`](./src/models/errors/evalsragascontextrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
780
|
-
* [`EvalsRagasContextEntitiesRecallResponseBody`](./src/models/errors/evalsragascontextentitiesrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
781
|
-
* [`EvalsRagasCorrectnessResponseBody`](./src/models/errors/evalsragascorrectnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
782
|
-
* [`EvalsRagasFaithfulnessResponseBody`](./src/models/errors/evalsragasfaithfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
783
|
-
* [`EvalsRagasHarmfulnessResponseBody`](./src/models/errors/evalsragasharmfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
784
|
-
* [`EvalsRagasMaliciousnessResponseBody`](./src/models/errors/evalsragasmaliciousnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
785
|
-
* [`EvalsRagasNoiseSensitivityResponseBody`](./src/models/errors/evalsragasnoisesensitivityresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
786
|
-
* [`EvalsRagasResponseRelevancyResponseBody`](./src/models/errors/evalsragasresponserelevancyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
787
|
-
* [`EvalsRagasSummarizationResponseBody`](./src/models/errors/evalsragassummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of
|
|
788
|
-
* [`InvokeEvalResponseBody`](./src/models/errors/invokeevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of
|
|
789
|
-
* [`EvalsBertScoreEvalsResponseBody`](./src/models/errors/evalsbertscoreevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
790
|
-
* [`EvalsBleuScoreEvalsResponseBody`](./src/models/errors/evalsbleuscoreevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
791
|
-
* [`EvalsContainsAllEvalsResponseBody`](./src/models/errors/evalscontainsallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
792
|
-
* [`EvalsContainsAnyEvalsResponseBody`](./src/models/errors/evalscontainsanyevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
793
|
-
* [`EvalsContainsEmailEvalsResponseBody`](./src/models/errors/evalscontainsemailevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
794
|
-
* [`EvalsContainsNoneEvalsResponseBody`](./src/models/errors/evalscontainsnoneevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
795
|
-
* [`EvalsContainsUrlEvalsResponseBody`](./src/models/errors/evalscontainsurlevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
796
|
-
* [`EvalsContainsValidLinkEvalsResponseBody`](./src/models/errors/evalscontainsvalidlinkevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
797
|
-
* [`EvalsContainsEvalsResponseBody`](./src/models/errors/evalscontainsevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
798
|
-
* [`EvalsEndsWithEvalsResponseBody`](./src/models/errors/evalsendswithevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
799
|
-
* [`EvalsExactMatchEvalsResponseBody`](./src/models/errors/evalsexactmatchevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
800
|
-
* [`EvalsLengthBetweenEvalsResponseBody`](./src/models/errors/evalslengthbetweenevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
801
|
-
* [`EvalsLengthGreaterThanEvalsResponseBody`](./src/models/errors/evalslengthgreaterthanevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
802
|
-
* [`EvalsLengthLessThanEvalsResponseBody`](./src/models/errors/evalslengthlessthanevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
803
|
-
* [`EvalsValidJsonEvalsResponseBody`](./src/models/errors/evalsvalidjsonevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
804
|
-
* [`EvalsAgeAppropriateEvalsResponseBody`](./src/models/errors/evalsageappropriateevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
805
|
-
* [`EvalsBotDetectionEvalsResponseBody`](./src/models/errors/evalsbotdetectionevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
806
|
-
* [`EvalsFactCheckingKnowledgeBaseEvalsResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
807
|
-
* [`EvalsGrammarEvalsResponseBody`](./src/models/errors/evalsgrammarevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
808
|
-
* [`EvalsLocalizationEvalsResponseBody`](./src/models/errors/evalslocalizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
809
|
-
* [`EvalsPiiEvalsResponseBody`](./src/models/errors/evalspiievalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
810
|
-
* [`EvalsSentimentClassificationEvalsResponseBody`](./src/models/errors/evalssentimentclassificationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
811
|
-
* [`EvalsSummarizationEvalsResponseBody`](./src/models/errors/evalssummarizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
812
|
-
* [`EvalsToneOfVoiceEvalsResponseBody`](./src/models/errors/evalstoneofvoiceevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
813
|
-
* [`EvalsTranslationEvalsResponseBody`](./src/models/errors/evalstranslationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
814
|
-
* [`EvalsRagasCoherenceEvalsResponseBody`](./src/models/errors/evalsragascoherenceevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
815
|
-
* [`EvalsRagasConcisenessEvalsResponseBody`](./src/models/errors/evalsragasconcisenessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
816
|
-
* [`EvalsRagasContextPrecisionEvalsResponseBody`](./src/models/errors/evalsragascontextprecisionevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
817
|
-
* [`EvalsRagasContextRecallEvalsResponseBody`](./src/models/errors/evalsragascontextrecallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
818
|
-
* [`EvalsRagasContextEntitiesRecallEvalsResponseBody`](./src/models/errors/evalsragascontextentitiesrecallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
819
|
-
* [`EvalsRagasCorrectnessEvalsResponseBody`](./src/models/errors/evalsragascorrectnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
820
|
-
* [`EvalsRagasFaithfulnessEvalsResponseBody`](./src/models/errors/evalsragasfaithfulnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
821
|
-
* [`EvalsRagasHarmfulnessEvalsResponseBody`](./src/models/errors/evalsragasharmfulnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
822
|
-
* [`EvalsRagasMaliciousnessEvalsResponseBody`](./src/models/errors/evalsragasmaliciousnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
823
|
-
* [`EvalsRagasNoiseSensitivityEvalsResponseBody`](./src/models/errors/evalsragasnoisesensitivityevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
824
|
-
* [`EvalsRagasResponseRelevancyEvalsResponseBody`](./src/models/errors/evalsragasresponserelevancyevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
825
|
-
* [`EvalsRagasSummarizationEvalsResponseBody`](./src/models/errors/evalsragassummarizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of
|
|
826
|
-
* [`InvokeEvalEvalsResponseBody`](./src/models/errors/invokeevalevalsresponsebody.ts): Error running the evaluator. Status code `500`. Applicable to 1 of
|
|
743
|
+
* [`HonoApiError`](./src/models/errors/honoapierror.ts): Applicable to 6 of 94 methods.*
|
|
744
|
+
* [`RetrieveContactResponseBody`](./src/models/errors/retrievecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
745
|
+
* [`UpdateContactResponseBody`](./src/models/errors/updatecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
746
|
+
* [`DeleteContactResponseBody`](./src/models/errors/deletecontactresponsebody.ts): Contact not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
747
|
+
* [`UpdatePromptResponseBody`](./src/models/errors/updatepromptresponsebody.ts): Prompt not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
748
|
+
* [`GetPromptVersionResponseBody`](./src/models/errors/getpromptversionresponsebody.ts): Not Found - The prompt or prompt version does not exist. Status code `404`. Applicable to 1 of 94 methods.*
|
|
749
|
+
* [`GetEvalsResponseBody`](./src/models/errors/getevalsresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
750
|
+
* [`CreateEvalResponseBody`](./src/models/errors/createevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
751
|
+
* [`UpdateEvalResponseBody`](./src/models/errors/updateevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
752
|
+
* [`DeleteEvalResponseBody`](./src/models/errors/deleteevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
753
|
+
* [`EvalsBertScoreResponseBody`](./src/models/errors/evalsbertscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
754
|
+
* [`EvalsBleuScoreResponseBody`](./src/models/errors/evalsbleuscoreresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
755
|
+
* [`EvalsContainsAllResponseBody`](./src/models/errors/evalscontainsallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
756
|
+
* [`EvalsContainsAnyResponseBody`](./src/models/errors/evalscontainsanyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
757
|
+
* [`EvalsContainsEmailResponseBody`](./src/models/errors/evalscontainsemailresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
758
|
+
* [`EvalsContainsNoneResponseBody`](./src/models/errors/evalscontainsnoneresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
759
|
+
* [`EvalsContainsUrlResponseBody`](./src/models/errors/evalscontainsurlresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
760
|
+
* [`EvalsContainsValidLinkResponseBody`](./src/models/errors/evalscontainsvalidlinkresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
761
|
+
* [`EvalsContainsResponseBody`](./src/models/errors/evalscontainsresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
762
|
+
* [`EvalsEndsWithResponseBody`](./src/models/errors/evalsendswithresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
763
|
+
* [`EvalsExactMatchResponseBody`](./src/models/errors/evalsexactmatchresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
764
|
+
* [`EvalsLengthBetweenResponseBody`](./src/models/errors/evalslengthbetweenresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
765
|
+
* [`EvalsLengthGreaterThanResponseBody`](./src/models/errors/evalslengthgreaterthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
766
|
+
* [`EvalsLengthLessThanResponseBody`](./src/models/errors/evalslengthlessthanresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
767
|
+
* [`EvalsValidJsonResponseBody`](./src/models/errors/evalsvalidjsonresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
768
|
+
* [`EvalsAgeAppropriateResponseBody`](./src/models/errors/evalsageappropriateresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
769
|
+
* [`EvalsBotDetectionResponseBody`](./src/models/errors/evalsbotdetectionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
770
|
+
* [`EvalsFactCheckingKnowledgeBaseResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
771
|
+
* [`EvalsGrammarResponseBody`](./src/models/errors/evalsgrammarresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
772
|
+
* [`EvalsLocalizationResponseBody`](./src/models/errors/evalslocalizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
773
|
+
* [`EvalsPiiResponseBody`](./src/models/errors/evalspiiresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
774
|
+
* [`EvalsSentimentClassificationResponseBody`](./src/models/errors/evalssentimentclassificationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
775
|
+
* [`EvalsSummarizationResponseBody`](./src/models/errors/evalssummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
776
|
+
* [`EvalsToneOfVoiceResponseBody`](./src/models/errors/evalstoneofvoiceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
777
|
+
* [`EvalsTranslationResponseBody`](./src/models/errors/evalstranslationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
778
|
+
* [`EvalsRagasCoherenceResponseBody`](./src/models/errors/evalsragascoherenceresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
779
|
+
* [`EvalsRagasConcisenessResponseBody`](./src/models/errors/evalsragasconcisenessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
780
|
+
* [`EvalsRagasContextPrecisionResponseBody`](./src/models/errors/evalsragascontextprecisionresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
781
|
+
* [`EvalsRagasContextRecallResponseBody`](./src/models/errors/evalsragascontextrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
782
|
+
* [`EvalsRagasContextEntitiesRecallResponseBody`](./src/models/errors/evalsragascontextentitiesrecallresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
783
|
+
* [`EvalsRagasCorrectnessResponseBody`](./src/models/errors/evalsragascorrectnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
784
|
+
* [`EvalsRagasFaithfulnessResponseBody`](./src/models/errors/evalsragasfaithfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
785
|
+
* [`EvalsRagasHarmfulnessResponseBody`](./src/models/errors/evalsragasharmfulnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
786
|
+
* [`EvalsRagasMaliciousnessResponseBody`](./src/models/errors/evalsragasmaliciousnessresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
787
|
+
* [`EvalsRagasNoiseSensitivityResponseBody`](./src/models/errors/evalsragasnoisesensitivityresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
788
|
+
* [`EvalsRagasResponseRelevancyResponseBody`](./src/models/errors/evalsragasresponserelevancyresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
789
|
+
* [`EvalsRagasSummarizationResponseBody`](./src/models/errors/evalsragassummarizationresponsebody.ts): Evaluator not found. Status code `404`. Applicable to 1 of 94 methods.*
|
|
790
|
+
* [`InvokeEvalResponseBody`](./src/models/errors/invokeevalresponsebody.ts): Workspace ID is not found on the request. Status code `404`. Applicable to 1 of 94 methods.*
|
|
791
|
+
* [`EvalsBertScoreEvalsResponseBody`](./src/models/errors/evalsbertscoreevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
792
|
+
* [`EvalsBleuScoreEvalsResponseBody`](./src/models/errors/evalsbleuscoreevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
793
|
+
* [`EvalsContainsAllEvalsResponseBody`](./src/models/errors/evalscontainsallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
794
|
+
* [`EvalsContainsAnyEvalsResponseBody`](./src/models/errors/evalscontainsanyevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
795
|
+
* [`EvalsContainsEmailEvalsResponseBody`](./src/models/errors/evalscontainsemailevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
796
|
+
* [`EvalsContainsNoneEvalsResponseBody`](./src/models/errors/evalscontainsnoneevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
797
|
+
* [`EvalsContainsUrlEvalsResponseBody`](./src/models/errors/evalscontainsurlevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
798
|
+
* [`EvalsContainsValidLinkEvalsResponseBody`](./src/models/errors/evalscontainsvalidlinkevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
799
|
+
* [`EvalsContainsEvalsResponseBody`](./src/models/errors/evalscontainsevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
800
|
+
* [`EvalsEndsWithEvalsResponseBody`](./src/models/errors/evalsendswithevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
801
|
+
* [`EvalsExactMatchEvalsResponseBody`](./src/models/errors/evalsexactmatchevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
802
|
+
* [`EvalsLengthBetweenEvalsResponseBody`](./src/models/errors/evalslengthbetweenevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
803
|
+
* [`EvalsLengthGreaterThanEvalsResponseBody`](./src/models/errors/evalslengthgreaterthanevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
804
|
+
* [`EvalsLengthLessThanEvalsResponseBody`](./src/models/errors/evalslengthlessthanevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
805
|
+
* [`EvalsValidJsonEvalsResponseBody`](./src/models/errors/evalsvalidjsonevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
806
|
+
* [`EvalsAgeAppropriateEvalsResponseBody`](./src/models/errors/evalsageappropriateevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
807
|
+
* [`EvalsBotDetectionEvalsResponseBody`](./src/models/errors/evalsbotdetectionevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
808
|
+
* [`EvalsFactCheckingKnowledgeBaseEvalsResponseBody`](./src/models/errors/evalsfactcheckingknowledgebaseevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
809
|
+
* [`EvalsGrammarEvalsResponseBody`](./src/models/errors/evalsgrammarevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
810
|
+
* [`EvalsLocalizationEvalsResponseBody`](./src/models/errors/evalslocalizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
811
|
+
* [`EvalsPiiEvalsResponseBody`](./src/models/errors/evalspiievalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
812
|
+
* [`EvalsSentimentClassificationEvalsResponseBody`](./src/models/errors/evalssentimentclassificationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
813
|
+
* [`EvalsSummarizationEvalsResponseBody`](./src/models/errors/evalssummarizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
814
|
+
* [`EvalsToneOfVoiceEvalsResponseBody`](./src/models/errors/evalstoneofvoiceevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
815
|
+
* [`EvalsTranslationEvalsResponseBody`](./src/models/errors/evalstranslationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
816
|
+
* [`EvalsRagasCoherenceEvalsResponseBody`](./src/models/errors/evalsragascoherenceevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
817
|
+
* [`EvalsRagasConcisenessEvalsResponseBody`](./src/models/errors/evalsragasconcisenessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
818
|
+
* [`EvalsRagasContextPrecisionEvalsResponseBody`](./src/models/errors/evalsragascontextprecisionevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
819
|
+
* [`EvalsRagasContextRecallEvalsResponseBody`](./src/models/errors/evalsragascontextrecallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
820
|
+
* [`EvalsRagasContextEntitiesRecallEvalsResponseBody`](./src/models/errors/evalsragascontextentitiesrecallevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
821
|
+
* [`EvalsRagasCorrectnessEvalsResponseBody`](./src/models/errors/evalsragascorrectnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
822
|
+
* [`EvalsRagasFaithfulnessEvalsResponseBody`](./src/models/errors/evalsragasfaithfulnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
823
|
+
* [`EvalsRagasHarmfulnessEvalsResponseBody`](./src/models/errors/evalsragasharmfulnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
824
|
+
* [`EvalsRagasMaliciousnessEvalsResponseBody`](./src/models/errors/evalsragasmaliciousnessevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
825
|
+
* [`EvalsRagasNoiseSensitivityEvalsResponseBody`](./src/models/errors/evalsragasnoisesensitivityevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
826
|
+
* [`EvalsRagasResponseRelevancyEvalsResponseBody`](./src/models/errors/evalsragasresponserelevancyevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
827
|
+
* [`EvalsRagasSummarizationEvalsResponseBody`](./src/models/errors/evalsragassummarizationevalsresponsebody.ts): Internal server error. Status code `500`. Applicable to 1 of 94 methods.*
|
|
828
|
+
* [`InvokeEvalEvalsResponseBody`](./src/models/errors/invokeevalevalsresponsebody.ts): Error running the evaluator. Status code `500`. Applicable to 1 of 94 methods.*
|
|
827
829
|
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
828
830
|
|
|
829
831
|
</details>
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
#
|
|
2
|
-
(*
|
|
1
|
+
# Chunking
|
|
2
|
+
(*chunking*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [parse](#parse) - Parse text
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## parse
|
|
11
11
|
|
|
12
12
|
Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies.
|
|
13
13
|
|
|
@@ -21,7 +21,7 @@ const orq = new Orq({
|
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
async function run() {
|
|
24
|
-
const result = await orq.
|
|
24
|
+
const result = await orq.chunking.parse({
|
|
25
25
|
text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
|
|
26
26
|
metadata: true,
|
|
27
27
|
strategy: "semantic",
|
|
@@ -44,7 +44,7 @@ The standalone function version of this method:
|
|
|
44
44
|
|
|
45
45
|
```typescript
|
|
46
46
|
import { OrqCore } from "@orq-ai/node/core.js";
|
|
47
|
-
import {
|
|
47
|
+
import { chunkingParse } from "@orq-ai/node/funcs/chunkingParse.js";
|
|
48
48
|
|
|
49
49
|
// Use `OrqCore` for best tree-shaking performance.
|
|
50
50
|
// You can create one instance of it to use across an application.
|
|
@@ -53,7 +53,7 @@ const orq = new OrqCore({
|
|
|
53
53
|
});
|
|
54
54
|
|
|
55
55
|
async function run() {
|
|
56
|
-
const res = await
|
|
56
|
+
const res = await chunkingParse(orq, {
|
|
57
57
|
text: "The quick brown fox jumps over the lazy dog. This is a sample text that will be chunked into smaller pieces. Each chunk will maintain context while respecting the maximum chunk size.",
|
|
58
58
|
metadata: true,
|
|
59
59
|
strategy: "semantic",
|
|
@@ -67,7 +67,7 @@ async function run() {
|
|
|
67
67
|
const { value: result } = res;
|
|
68
68
|
console.log(result);
|
|
69
69
|
} else {
|
|
70
|
-
console.log("
|
|
70
|
+
console.log("chunkingParse failed:", res.error);
|
|
71
71
|
}
|
|
72
72
|
}
|
|
73
73
|
|
|
@@ -78,14 +78,14 @@ run();
|
|
|
78
78
|
|
|
79
79
|
| Parameter | Type | Required | Description |
|
|
80
80
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
81
|
-
| `request` | [operations.
|
|
81
|
+
| `request` | [operations.ParseChunkingRequest](../../models/operations/parsechunkingrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
82
82
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
83
83
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
84
84
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
85
85
|
|
|
86
86
|
### Response
|
|
87
87
|
|
|
88
|
-
**Promise\<[operations.
|
|
88
|
+
**Promise\<[operations.ParseResponseBody](../../models/operations/parseresponsebody.md)\>**
|
|
89
89
|
|
|
90
90
|
### Errors
|
|
91
91
|
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
8
|
* [list](#list) - List all knowledge bases
|
|
9
|
+
* [create](#create) - Create a knowledge
|
|
9
10
|
* [retrieve](#retrieve) - Retrieves a knowledge base
|
|
10
11
|
* [update](#update) - Updates a knowledge
|
|
11
12
|
* [delete](#delete) - Deletes a knowledge
|
|
@@ -89,6 +90,82 @@ run();
|
|
|
89
90
|
| --------------- | --------------- | --------------- |
|
|
90
91
|
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
91
92
|
|
|
93
|
+
## create
|
|
94
|
+
|
|
95
|
+
Create a knowledge
|
|
96
|
+
|
|
97
|
+
### Example Usage
|
|
98
|
+
|
|
99
|
+
```typescript
|
|
100
|
+
import { Orq } from "@orq-ai/node";
|
|
101
|
+
|
|
102
|
+
const orq = new Orq({
|
|
103
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
async function run() {
|
|
107
|
+
const result = await orq.knowledge.create({
|
|
108
|
+
key: "<key>",
|
|
109
|
+
embeddingModel: "<value>",
|
|
110
|
+
path: "Default",
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
console.log(result);
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
run();
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Standalone function
|
|
120
|
+
|
|
121
|
+
The standalone function version of this method:
|
|
122
|
+
|
|
123
|
+
```typescript
|
|
124
|
+
import { OrqCore } from "@orq-ai/node/core.js";
|
|
125
|
+
import { knowledgeCreate } from "@orq-ai/node/funcs/knowledgeCreate.js";
|
|
126
|
+
|
|
127
|
+
// Use `OrqCore` for best tree-shaking performance.
|
|
128
|
+
// You can create one instance of it to use across an application.
|
|
129
|
+
const orq = new OrqCore({
|
|
130
|
+
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
async function run() {
|
|
134
|
+
const res = await knowledgeCreate(orq, {
|
|
135
|
+
key: "<key>",
|
|
136
|
+
embeddingModel: "<value>",
|
|
137
|
+
path: "Default",
|
|
138
|
+
});
|
|
139
|
+
if (res.ok) {
|
|
140
|
+
const { value: result } = res;
|
|
141
|
+
console.log(result);
|
|
142
|
+
} else {
|
|
143
|
+
console.log("knowledgeCreate failed:", res.error);
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
run();
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
| Parameter | Type | Required | Description |
|
|
153
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
154
|
+
| `request` | [operations.CreateKnowledgeRequestBody](../../models/operations/createknowledgerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
155
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
156
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
157
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
158
|
+
|
|
159
|
+
### Response
|
|
160
|
+
|
|
161
|
+
**Promise\<[operations.CreateKnowledgeResponseBody](../../models/operations/createknowledgeresponsebody.md)\>**
|
|
162
|
+
|
|
163
|
+
### Errors
|
|
164
|
+
|
|
165
|
+
| Error Type | Status Code | Content Type |
|
|
166
|
+
| --------------- | --------------- | --------------- |
|
|
167
|
+
| errors.APIError | 4XX, 5XX | \*/\* |
|
|
168
|
+
|
|
92
169
|
## retrieve
|
|
93
170
|
|
|
94
171
|
Retrieve a knowledge base with the settings.
|
package/packages/orq-rc/jsr.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orq-ai/node",
|
|
3
|
-
"version": "3.10.0-rc.
|
|
3
|
+
"version": "3.10.0-rc.13",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@orq-ai/node",
|
|
9
|
-
"version": "3.10.0-rc.
|
|
9
|
+
"version": "3.10.0-rc.13",
|
|
10
10
|
"bin": {
|
|
11
11
|
"mcp": "bin/mcp-server.js"
|
|
12
12
|
},
|
|
@@ -25,18 +25,18 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
25
25
|
import { Result } from "../types/fp.js";
|
|
26
26
|
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* Parse text
|
|
29
29
|
*
|
|
30
30
|
* @remarks
|
|
31
31
|
* Split large text documents into smaller, manageable chunks using different chunking strategies optimized for RAG (Retrieval-Augmented Generation) workflows. This endpoint supports multiple chunking algorithms including token-based, sentence-based, recursive, semantic, and specialized strategies.
|
|
32
32
|
*/
|
|
33
|
-
export function
|
|
33
|
+
export function chunkingParse(
|
|
34
34
|
client: OrqCore,
|
|
35
|
-
request: operations.
|
|
35
|
+
request: operations.ParseChunkingRequest,
|
|
36
36
|
options?: RequestOptions,
|
|
37
37
|
): APIPromise<
|
|
38
38
|
Result<
|
|
39
|
-
operations.
|
|
39
|
+
operations.ParseResponseBody,
|
|
40
40
|
| OrqError
|
|
41
41
|
| ResponseValidationError
|
|
42
42
|
| ConnectionError
|
|
@@ -56,12 +56,12 @@ export function knowledgeBasesChunkText(
|
|
|
56
56
|
|
|
57
57
|
async function $do(
|
|
58
58
|
client: OrqCore,
|
|
59
|
-
request: operations.
|
|
59
|
+
request: operations.ParseChunkingRequest,
|
|
60
60
|
options?: RequestOptions,
|
|
61
61
|
): Promise<
|
|
62
62
|
[
|
|
63
63
|
Result<
|
|
64
|
-
operations.
|
|
64
|
+
operations.ParseResponseBody,
|
|
65
65
|
| OrqError
|
|
66
66
|
| ResponseValidationError
|
|
67
67
|
| ConnectionError
|
|
@@ -76,7 +76,7 @@ async function $do(
|
|
|
76
76
|
> {
|
|
77
77
|
const parsed = safeParse(
|
|
78
78
|
request,
|
|
79
|
-
(value) => operations.
|
|
79
|
+
(value) => operations.ParseChunkingRequest$outboundSchema.parse(value),
|
|
80
80
|
"Input validation failed",
|
|
81
81
|
);
|
|
82
82
|
if (!parsed.ok) {
|
|
@@ -85,7 +85,7 @@ async function $do(
|
|
|
85
85
|
const payload = parsed.value;
|
|
86
86
|
const body = encodeJSON("body", payload, { explode: true });
|
|
87
87
|
|
|
88
|
-
const path = pathToFunc("/v2/
|
|
88
|
+
const path = pathToFunc("/v2/chunking")();
|
|
89
89
|
|
|
90
90
|
const headers = new Headers(compactMap({
|
|
91
91
|
"Content-Type": "application/json",
|
|
@@ -99,7 +99,7 @@ async function $do(
|
|
|
99
99
|
const context = {
|
|
100
100
|
options: client._options,
|
|
101
101
|
baseURL: options?.serverURL ?? client._baseURL ?? "",
|
|
102
|
-
operationID: "
|
|
102
|
+
operationID: "parse",
|
|
103
103
|
oAuth2Scopes: [],
|
|
104
104
|
|
|
105
105
|
resolvedSecurity: requestSecurity,
|
|
@@ -138,7 +138,7 @@ async function $do(
|
|
|
138
138
|
const response = doResult.value;
|
|
139
139
|
|
|
140
140
|
const [result] = await M.match<
|
|
141
|
-
operations.
|
|
141
|
+
operations.ParseResponseBody,
|
|
142
142
|
| OrqError
|
|
143
143
|
| ResponseValidationError
|
|
144
144
|
| ConnectionError
|
|
@@ -148,7 +148,7 @@ async function $do(
|
|
|
148
148
|
| UnexpectedClientError
|
|
149
149
|
| SDKValidationError
|
|
150
150
|
>(
|
|
151
|
-
M.json(200, operations.
|
|
151
|
+
M.json(200, operations.ParseResponseBody$inboundSchema),
|
|
152
152
|
M.fail("4XX"),
|
|
153
153
|
M.fail("5XX"),
|
|
154
154
|
)(response, req);
|