docs: update examples

Author: stainless-app[bot]

packages/mcp-server/src/local-docs-search.ts

@@ -211,21 +211,21 @@ const EMBEDDED_METHODS: MethodEntry[] = [
     ],
     response: '{ results: { index: number; document: object; }[]; usage: { input_tokens: number; }; }',
     markdown:
-      "## create\n\n`client.enrichments.create(model: 'kanon-2-enricher', texts: string[] | string, overflow_strategy?: 'auto' | 'drop_end' | 'chunk'): { results: object[]; usage: object; }`\n\n**post** `/enrichments`\n\nEnrich documents with an Isaacus enrichment model.\n\n### Parameters\n\n- `model: 'kanon-2-enricher'`\n  The ID of the [model](https://docs.isaacus.com/models#enrichment) to use for enrichment.\n\n- `texts: string[] | string`\n  A text or array of texts to be enriched, each containing at least one non-whitespace character.\n\nNo more than 8 texts can be enriched in a single request.\n\n- `overflow_strategy?: 'auto' | 'drop_end' | 'chunk'`\n  The strategy for handling content exceeding the model's maximum input length.\n\n`auto`, which is the recommended setting, currently behaves the same as `chunk`, which intelligently breaks the input up into smaller chunks and then stitches the results back together into a single prediction. In the future `auto` may implement even more sophisticated strategies for handling long contexts such as leveraging chunk overlap and/or a specialized stitching model.\n\n`chunk` breaks the input up into smaller chunks that fit within the model's context window and then intelligently merges the results into a single prediction at the cost of a minor accuracy drop.\n\n`drop_end` drops tokens from the end of input exceeding the model's maximum input length.\n\n`null`, which is the default setting, raises an error if the input exceeds the model's maximum input length.\n\n### Returns\n\n- `{ results: { index: number; document: object; }[]; usage: { input_tokens: number; }; }`\n\n  - `results: { index: number; document: { text: string; title: object; subtitle: object; type: 'statute' | 'regulation' | 'decision' | 'contract' | 'other'; jurisdiction: string; segments: object[]; crossreferences: object[]; locations: object[]; persons: object[]; emails: object[]; websites: object[]; phone_numbers: object[]; id_numbers: object[]; terms: object[]; external_documents: object[]; quotes: object[]; dates: object[]; headings: object[]; junk: object[]; version: 'ilgs@1'; }; }[]`\n  - `usage: { input_tokens: number; }`\n\n### Example\n\n```typescript\nimport Isaacus from 'isaacus';\n\nconst client = new Isaacus();\n\nconst enrichmentResponse = await client.enrichments.create({ model: 'kanon-2-enricher', texts: ['1.5 You (the \"User\") agree to be bound by these Terms.'] });\n\nconsole.log(enrichmentResponse);\n```",
+      "## create\n\n`client.enrichments.create(model: 'kanon-2-enricher', texts: string[] | string, overflow_strategy?: 'auto' | 'drop_end' | 'chunk'): { results: object[]; usage: object; }`\n\n**post** `/enrichments`\n\nEnrich documents with an Isaacus enrichment model.\n\n### Parameters\n\n- `model: 'kanon-2-enricher'`\n  The ID of the [model](https://docs.isaacus.com/models#enrichment) to use for enrichment.\n\n- `texts: string[] | string`\n  A text or array of texts to be enriched, each containing at least one non-whitespace character.\n\nNo more than 8 texts can be enriched in a single request.\n\n- `overflow_strategy?: 'auto' | 'drop_end' | 'chunk'`\n  The strategy for handling content exceeding the model's maximum input length.\n\n`auto`, which is the recommended setting, currently behaves the same as `chunk`, which intelligently breaks the input up into smaller chunks and then stitches the results back together into a single prediction. In the future `auto` may implement even more sophisticated strategies for handling long contexts such as leveraging chunk overlap and/or a specialized stitching model.\n\n`chunk` breaks the input up into smaller chunks that fit within the model's context window and then intelligently merges the results into a single prediction at the cost of a minor accuracy drop.\n\n`drop_end` drops tokens from the end of input exceeding the model's maximum input length.\n\n`null`, which is the default setting, raises an error if the input exceeds the model's maximum input length.\n\n### Returns\n\n- `{ results: { index: number; document: object; }[]; usage: { input_tokens: number; }; }`\n\n  - `results: { index: number; document: { text: string; title: object; subtitle: object; type: 'statute' | 'regulation' | 'decision' | 'contract' | 'other'; jurisdiction: string; segments: object[]; crossreferences: object[]; locations: object[]; persons: object[]; emails: object[]; websites: object[]; phone_numbers: object[]; id_numbers: object[]; terms: object[]; external_documents: object[]; quotes: object[]; dates: object[]; headings: object[]; junk: object[]; version: 'ilgs@1'; }; }[]`\n  - `usage: { input_tokens: number; }`\n\n### Example\n\n```typescript\nimport Isaacus from 'isaacus';\n\nconst client = new Isaacus();\n\nconst enrichmentResponse = await client.enrichments.create({ model: 'kanon-2-enricher', texts: ['[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that \"§ 206 of Title 29 of the U.S. Code (the \"Labor Title\") does not apply to the plaintiff, Ms. Moody, given the definition of an \"employee\" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria.\"'] });\n\nconsole.log(enrichmentResponse);\n```",
     perLanguage: {
       http: {
         example:
-          'curl https://api.isaacus.com/v1/enrichments \\\n    -H \'Content-Type: application/json\' \\\n    -H "Authorization: Bearer $ISAACUS_API_KEY" \\\n    -d \'{\n          "model": "kanon-2-enricher",\n          "texts": [\n            "1.5 You (the \\\\"User\\\\") agree to be bound by these Terms."\n          ]\n        }\'',
+          'curl https://api.isaacus.com/v1/enrichments \\\n    -H \'Content-Type: application/json\' \\\n    -H "Authorization: Bearer $ISAACUS_API_KEY" \\\n    -d \'{\n          "model": "kanon-2-enricher",\n          "texts": [\n            "[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that \\\\"§ 206 of Title 29 of the U.S. Code (the \\\\"Labor Title\\\\") does not apply to the plaintiff, Ms. Moody, given the definition of an \\\\"employee\\\\" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria.\\\\""\n          ]\n        }\'',
       },
       python: {
         method: 'enrichments.create',
         example:
-          'import os\nfrom isaacus import Isaacus\n\nclient = Isaacus(\n    api_key=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted\n)\nenrichment_response = client.enrichments.create(\n    model="kanon-2-enricher",\n    texts=["1.5 You (the \\"User\\") agree to be bound by these Terms."],\n)\nprint(enrichment_response.results)',
+          'import os\nfrom isaacus import Isaacus\n\nclient = Isaacus(\n    api_key=os.environ.get("ISAACUS_API_KEY"),  # This is the default and can be omitted\n)\nenrichment_response = client.enrichments.create(\n    model="kanon-2-enricher",\n    texts=["[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that \\"§ 206 of Title 29 of the U.S. Code (the \\"Labor Title\\") does not apply to the plaintiff, Ms. Moody, given the definition of an \\"employee\\" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria.\\""],\n)\nprint(enrichment_response.results)',
       },
       typescript: {
         method: 'client.enrichments.create',
         example:
-          "import Isaacus from 'isaacus';\n\nconst client = new Isaacus({\n  apiKey: process.env['ISAACUS_API_KEY'], // This is the default and can be omitted\n});\n\nconst enrichmentResponse = await client.enrichments.create({\n  model: 'kanon-2-enricher',\n  texts: ['1.5 You (the \"User\") agree to be bound by these Terms.'],\n});\n\nconsole.log(enrichmentResponse.results);",
+          "import Isaacus from 'isaacus';\n\nconst client = new Isaacus({\n  apiKey: process.env['ISAACUS_API_KEY'], // This is the default and can be omitted\n});\n\nconst enrichmentResponse = await client.enrichments.create({\n  model: 'kanon-2-enricher',\n  texts: [\n    '[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that \"§ 206 of Title 29 of the U.S. Code (the \"Labor Title\") does not apply to the plaintiff, Ms. Moody, given the definition of an \"employee\" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria.\"',\n  ],\n});\n\nconsole.log(enrichmentResponse.results);",
       },
     },
   },

src/resources/enrichments.ts

@@ -17,7 +17,7 @@ export class Enrichments extends APIResource {
    * const enrichmentResponse = await client.enrichments.create({
    *   model: 'kanon-2-enricher',
    *   texts: [
-   *     '1.5 You (the "User") agree to be bound by these Terms.',
+   *     '[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that "§ 206 of Title 29 of the U.S. Code (the "Labor Title") does not apply to the plaintiff, Ms. Moody, given the definition of an "employee" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria."',
    *   ],
    * });
    * ```

tests/api-resources/classifications/universal.test.ts

@@ -34,8 +34,8 @@ describe('resource universal', () => {
       scoring_method: 'auto',
       chunking_options: {
         size: 512,
-        overlap_ratio: 0.1,
-        overlap_tokens: 10,
+        overlap_ratio: null,
+        overlap_tokens: null,
       },
     });
   });

tests/api-resources/embeddings.test.ts

@@ -30,7 +30,7 @@ describe('resource embeddings', () => {
       texts: ['Are restraints of trade enforceable under English law?', 'What is a non-compete clause?'],
       task: 'retrieval/query',
       overflow_strategy: 'drop_end',
-      dimensions: 1,
+      dimensions: 1792,
     });
   });
 });

tests/api-resources/enrichments.test.ts

@@ -12,7 +12,9 @@ describe('resource enrichments', () => {
   test.skip('create: only required params', async () => {
     const responsePromise = client.enrichments.create({
       model: 'kanon-2-enricher',
-      texts: ['1.5 You (the "User") agree to be bound by these Terms.'],
+      texts: [
+        '[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that "§ 206 of Title 29 of the U.S. Code (the "Labor Title") does not apply to the plaintiff, Ms. Moody, given the definition of an "employee" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria."',
+      ],
     });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
@@ -27,7 +29,9 @@ describe('resource enrichments', () => {
   test.skip('create: required and optional params', async () => {
     const response = await client.enrichments.create({
       model: 'kanon-2-enricher',
-      texts: ['1.5 You (the "User") agree to be bound by these Terms.'],
+      texts: [
+        '[42] The U.S. Attorney General, Mr. McGill, argued at ¶ 21 of the Filing that "§ 206 of Title 29 of the U.S. Code (the "Labor Title") does not apply to the plaintiff, Ms. Moody, given the definition of an "employee" at §203(e)(4) of the Labor Title does not include volunteers, and, regardless, she lives in Austria."',
+      ],
       overflow_strategy: 'auto',
     });
   });

tests/api-resources/extractions/qa.test.ts

@@ -37,9 +37,9 @@ describe('resource qa', () => {
       ignore_inextractability: false,
       top_k: 1,
       chunking_options: {
-        size: 512,
-        overlap_ratio: 0.1,
-        overlap_tokens: 10,
+        size: null,
+        overlap_ratio: null,
+        overlap_tokens: null,
       },
     });
   });

tests/api-resources/rerankings.test.ts

@@ -42,13 +42,13 @@ describe('resource rerankings', () => {
         'Negligence in tort law requires establishing a duty of care that the defendant owed to the plaintiff.',
         'The concept of negligence is central to tort law, with courts assessing whether a breach of duty caused harm.',
       ],
-      top_n: 1,
+      top_n: null,
       is_iql: false,
       scoring_method: 'auto',
       chunking_options: {
-        size: 512,
-        overlap_ratio: 0.1,
-        overlap_tokens: 10,
+        size: null,
+        overlap_ratio: null,
+        overlap_tokens: null,
       },
     });
   });