feat(api): enable ZDR on remaining AI endpoints via OpenAI (#1099)

Stainless-Generated-From: 14fabea8e3536ee170db274fdd08395bdfaad25a

Author: stlc-bot

src/resources/ai.ts

@@ -461,6 +461,15 @@ export interface AIExtractProductParams {
    * timeoutOpts object.
    */
   timeoutOpts?: AIExtractProductParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace AIExtractProductParams {

src/resources/industry.ts

@@ -230,6 +230,15 @@ export interface IndustryRetrieveNaicsParams {
    * timeoutOpts object.
    */
   timeoutOpts?: IndustryRetrieveNaicsParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace IndustryRetrieveNaicsParams {
@@ -291,6 +300,15 @@ export interface IndustryRetrieveSicParams {
    * published by the SEC. Defaults to `original_sic`.
    */
   type?: 'original_sic' | 'latest_sec';
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace IndustryRetrieveSicParams {

src/resources/parse.ts

@@ -259,10 +259,10 @@ export interface ParseHandleParams {
 
   /**
    * Query param: Set to enabled to bypass shared caches and omit request and
-   * response content from retained usage logs. Requires zero data retention to be
-   * enabled for your organization (contact support@context.dev), otherwise the
-   * request fails with ZDR_NOT_ENABLED. Successful ZDR responses include
-   * X-Context-ZDR: true.
+   * response content from retained usage logs. Asset uploads are skipped, so hosted
+   * image URLs are omitted. Requires zero data retention to be enabled for your
+   * organization (contact support@context.dev), otherwise the request fails with
+   * ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
    */
   zdr?: 'enabled' | 'disabled';
 }

src/resources/people.ts

@@ -304,6 +304,15 @@ export interface PersonEnrichParams {
    * timeoutOpts object.
    */
   timeoutOpts?: PersonEnrichParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace PersonEnrichParams {

src/resources/web.ts

@@ -2701,6 +2701,15 @@ export interface WebAnswersParams {
    * timeoutOpts object.
    */
   timeoutOpts?: WebAnswersParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace WebAnswersParams {
@@ -2829,6 +2838,15 @@ export interface WebExtractParams {
    * crawled page.
    */
   waitForMs?: number;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace WebExtractParams {
@@ -2943,6 +2961,15 @@ export interface WebExtractCompetitorsParams {
    * timeoutOpts object.
    */
   timeoutOpts?: WebExtractCompetitorsParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace WebExtractCompetitorsParams {
@@ -3069,6 +3096,15 @@ export interface WebExtractStyleguideParams {
    * timeoutOpts object.
    */
   timeoutOpts?: WebExtractStyleguideParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace WebExtractStyleguideParams {
@@ -3403,9 +3439,10 @@ export interface WebScreenshotParams {
 
   /**
    * Set to enabled to bypass shared caches and omit request and response content
-   * from retained usage logs. Requires zero data retention to be enabled for your
-   * organization (contact support@context.dev), otherwise the request fails with
-   * ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
    */
   zdr?: 'enabled' | 'disabled';
 }
@@ -3743,6 +3780,15 @@ export interface WebSearchParams {
    * timeoutOpts object.
    */
   timeoutOpts?: WebSearchParams.TimeoutOpts;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace WebSearchParams {
@@ -4500,9 +4546,10 @@ export interface WebWebScrapeBytesParams {
 
   /**
    * Set to enabled to bypass shared caches and omit request and response content
-   * from retained usage logs. Requires zero data retention to be enabled for your
-   * organization (contact support@context.dev), otherwise the request fails with
-   * ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
    */
   zdr?: 'enabled' | 'disabled';
 }
@@ -4840,9 +4887,10 @@ export interface WebWebScrapeHTMLParams {
 
   /**
    * Set to enabled to bypass shared caches and omit request and response content
-   * from retained usage logs. Requires zero data retention to be enabled for your
-   * organization (contact support@context.dev), otherwise the request fails with
-   * ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
    */
   zdr?: 'enabled' | 'disabled';
 }
@@ -5031,6 +5079,15 @@ export interface WebWebScrapeImagesParams {
    * shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
    */
   waitForMs?: number | null;
+
+  /**
+   * Set to enabled to bypass shared caches and omit request and response content
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
+   */
+  zdr?: 'enabled' | 'disabled';
 }
 
 export namespace WebWebScrapeImagesParams {
@@ -5094,7 +5151,7 @@ export namespace WebWebScrapeImagesParams {
 
     /**
      * Host materializable images on the Brand.dev CDN and return their URL and MIME
-     * type.
+     * type. Ignored when zero data retention is enabled.
      */
     hostedUrl?: boolean;
 
@@ -5456,9 +5513,10 @@ export interface WebWebScrapeMdParams {
 
   /**
    * Set to enabled to bypass shared caches and omit request and response content
-   * from retained usage logs. Requires zero data retention to be enabled for your
-   * organization (contact support@context.dev), otherwise the request fails with
-   * ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
    */
   zdr?: 'enabled' | 'disabled';
 }
@@ -5624,9 +5682,10 @@ export interface WebWebScrapeSitemapParams {
 
   /**
    * Set to enabled to bypass shared caches and omit request and response content
-   * from retained usage logs. Requires zero data retention to be enabled for your
-   * organization (contact support@context.dev), otherwise the request fails with
-   * ZDR_NOT_ENABLED. Successful ZDR responses include X-Context-ZDR: true.
+   * from retained usage logs. Asset uploads are skipped, so hosted image URLs are
+   * omitted. Requires zero data retention to be enabled for your organization
+   * (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
+   * Successful ZDR responses include X-Context-ZDR: true.
    */
   zdr?: 'enabled' | 'disabled';
 }

tests/api-resources/ai.test.ts

@@ -27,6 +27,7 @@ describe('resource ai', () => {
       maxAgeMs: 0,
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
+      zdr: 'enabled',
     });
   });
 

tests/api-resources/industry.test.ts

@@ -28,6 +28,7 @@ describe('resource industry', () => {
       minResults: 1,
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
+      zdr: 'enabled',
     });
   });
 
@@ -52,6 +53,7 @@ describe('resource industry', () => {
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
       type: 'original_sic',
+      zdr: 'enabled',
     });
   });
 });

tests/api-resources/web.test.ts

@@ -30,6 +30,7 @@ describe('resource web', () => {
       mode: 'fast',
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
+      zdr: 'enabled',
     });
   });
 
@@ -81,6 +82,7 @@ describe('resource web', () => {
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
       waitForMs: 0,
+      zdr: 'enabled',
     });
   });
 
@@ -103,6 +105,7 @@ describe('resource web', () => {
       numCompetitors: 1,
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
+      zdr: 'enabled',
     });
   });
 
@@ -159,6 +162,7 @@ describe('resource web', () => {
           maxAgeMs: 0,
           tags: ['production', 'team-alpha'],
           timeoutOpts: { milliseconds: 1, behavior: 'fail' },
+          zdr: 'enabled',
         },
         { path: '/_stainless_unknown_path' },
       ),
@@ -244,6 +248,7 @@ describe('resource web', () => {
       queryFanout: true,
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1000, behavior: 'fail' },
+      zdr: 'enabled',
     });
   });
 
@@ -383,6 +388,7 @@ describe('resource web', () => {
       tags: ['production', 'team-alpha'],
       timeoutOpts: { milliseconds: 1, behavior: 'fail' },
       waitForMs: 0,
+      zdr: 'enabled',
     });
   });