cloudflare 7.2.0 → 7.3.0

package/src/resources/ai-gateway/ai-gateway.ts

@@ -130,7 +130,9 @@ export class BaseAIGateway extends APIResource {
   static override readonly _key: readonly ['aiGateway'] = Object.freeze(['aiGateway'] as const);
 
   /**
-   * Creates a new AI Gateway.
+   * Creates an AI Gateway in the account with the specified caching, rate limiting,
+   * logging, and authentication settings. The gateway ID appears in request URLs and
+   * must be unique within the account.
    *
    * @example
    * ```ts
@@ -156,7 +158,8 @@ export class BaseAIGateway extends APIResource {
   }
 
   /**
-   * Updates an existing AI Gateway dataset.
+   * Updates the configuration of an AI Gateway, such as its caching, rate limiting,
+   * logging, and authentication settings.
    *
    * @example
    * ```ts
@@ -188,7 +191,7 @@ export class BaseAIGateway extends APIResource {
   }
 
   /**
-   * Lists all AI Gateway evaluator types configured for the account.
+   * Lists the AI Gateways in the account. Use `search` to filter by gateway ID.
    *
    * @example
    * ```ts
@@ -213,7 +216,7 @@ export class BaseAIGateway extends APIResource {
   }
 
   /**
-   * Deletes an AI Gateway dataset.
+   * Permanently deletes an AI Gateway, its configuration, and its stored logs.
    *
    * @example
    * ```ts
@@ -237,7 +240,7 @@ export class BaseAIGateway extends APIResource {
   }
 
   /**
-   * Retrieves details for a specific AI Gateway dataset.
+   * Retrieves the configuration of an AI Gateway.
    *
    * @example
    * ```ts
@@ -271,7 +274,7 @@ export type AIGatewayListResponsesV4PagePaginationArray = V4PagePaginationArray<
 
 export interface AIGatewayCreateResponse {
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   id: string;
 
@@ -523,7 +526,7 @@ export namespace AIGatewayCreateResponse {
 
 export interface AIGatewayUpdateResponse {
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   id: string;
 
@@ -775,7 +778,7 @@ export namespace AIGatewayUpdateResponse {
 
 export interface AIGatewayListResponse {
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   id: string;
 
@@ -1027,7 +1030,7 @@ export namespace AIGatewayListResponse {
 
 export interface AIGatewayDeleteResponse {
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   id: string;
 
@@ -1279,7 +1282,7 @@ export namespace AIGatewayDeleteResponse {
 
 export interface AIGatewayGetResponse {
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   id: string;
 
@@ -1536,7 +1539,7 @@ export interface AIGatewayCreateParams {
   account_id: string;
 
   /**
-   * Body param: gateway id
+   * Body param: Unique identifier of the AI Gateway within the account.
    */
   id: string;
 
@@ -1576,6 +1579,21 @@ export interface AIGatewayCreateParams {
    */
   byok_only?: boolean;
 
+  /**
+   * Body param
+   */
+  dlp?: AIGatewayCreateParams.UnionMember0 | AIGatewayCreateParams.UnionMember1;
+
+  /**
+   * Body param
+   */
+  guardrails?: AIGatewayCreateParams.Guardrails | null;
+
+  /**
+   * Body param
+   */
+  log_classification?: boolean;
+
   /**
    * Body param
    */
@@ -1596,6 +1614,11 @@ export interface AIGatewayCreateParams {
    */
   logpush_public_key?: string | null;
 
+  /**
+   * Body param
+   */
+  otel?: Array<AIGatewayCreateParams.Otel> | null;
+
   /**
    * Body param
    */
@@ -1616,11 +1639,21 @@ export interface AIGatewayCreateParams {
    */
   retry_max_attempts?: number | null;
 
+  /**
+   * Body param
+   */
+  spend_limits?: AIGatewayCreateParams.SpendLimits | null;
+
   /**
    * Body param
    */
   store_id?: string | null;
 
+  /**
+   * Body param
+   */
+  stripe?: AIGatewayCreateParams.Stripe | null;
+
   /**
    * Body param: Controls how Workers AI inference calls routed through this gateway
    * are billed. 'postpaid' bills the account directly through Workers AI; 'unified'
@@ -1635,6 +1668,178 @@ export interface AIGatewayCreateParams {
   zdr?: boolean;
 }
 
+export namespace AIGatewayCreateParams {
+  export interface UnionMember0 {
+    action: 'BLOCK' | 'FLAG';
+
+    enabled: boolean;
+
+    profiles: Array<string>;
+  }
+
+  export interface UnionMember1 {
+    enabled: boolean;
+
+    policies: Array<UnionMember1.Policy>;
+  }
+
+  export namespace UnionMember1 {
+    export interface Policy {
+      id: string;
+
+      action: 'FLAG' | 'BLOCK';
+
+      check: Array<'REQUEST' | 'RESPONSE'>;
+
+      enabled: boolean;
+
+      profiles: Array<string>;
+    }
+  }
+
+  export interface Guardrails {
+    prompt: Guardrails.Prompt;
+
+    response: Guardrails.Response;
+  }
+
+  export namespace Guardrails {
+    export interface Prompt {
+      P1?: 'FLAG' | 'BLOCK';
+
+      S1?: 'FLAG' | 'BLOCK';
+
+      S10?: 'FLAG' | 'BLOCK';
+
+      S11?: 'FLAG' | 'BLOCK';
+
+      S12?: 'FLAG' | 'BLOCK';
+
+      S13?: 'FLAG' | 'BLOCK';
+
+      S2?: 'FLAG' | 'BLOCK';
+
+      S3?: 'FLAG' | 'BLOCK';
+
+      S4?: 'FLAG' | 'BLOCK';
+
+      S5?: 'FLAG' | 'BLOCK';
+
+      S6?: 'FLAG' | 'BLOCK';
+
+      S7?: 'FLAG' | 'BLOCK';
+
+      S8?: 'FLAG' | 'BLOCK';
+
+      S9?: 'FLAG' | 'BLOCK';
+    }
+
+    export interface Response {
+      P1?: 'FLAG' | 'BLOCK';
+
+      S1?: 'FLAG' | 'BLOCK';
+
+      S10?: 'FLAG' | 'BLOCK';
+
+      S11?: 'FLAG' | 'BLOCK';
+
+      S12?: 'FLAG' | 'BLOCK';
+
+      S13?: 'FLAG' | 'BLOCK';
+
+      S2?: 'FLAG' | 'BLOCK';
+
+      S3?: 'FLAG' | 'BLOCK';
+
+      S4?: 'FLAG' | 'BLOCK';
+
+      S5?: 'FLAG' | 'BLOCK';
+
+      S6?: 'FLAG' | 'BLOCK';
+
+      S7?: 'FLAG' | 'BLOCK';
+
+      S8?: 'FLAG' | 'BLOCK';
+
+      S9?: 'FLAG' | 'BLOCK';
+    }
+  }
+
+  export interface Otel {
+    headers: { [key: string]: string };
+
+    url: string;
+
+    authorization?: string;
+
+    content_type?: 'json' | 'protobuf';
+  }
+
+  export interface SpendLimits {
+    enabled?: boolean;
+
+    rules?: Array<SpendLimits.Rule>;
+  }
+
+  export namespace SpendLimits {
+    export interface Rule {
+      limit: number;
+
+      limitType: 'cost';
+
+      window: number;
+
+      id?: string;
+
+      enabled?: boolean;
+
+      metadata?: { [key: string]: Rule.Mode | Rule.UnionMember1 };
+
+      model?: Rule.Model;
+
+      provider?: Rule.Provider;
+
+      technique?: 'fixed' | 'sliding';
+    }
+
+    export namespace Rule {
+      export interface Mode {
+        mode: 'partition';
+      }
+
+      export interface UnionMember1 {
+        mode: 'filter';
+
+        values: Array<string>;
+      }
+
+      export interface Model {
+        mode: 'filter';
+
+        values: Array<string>;
+      }
+
+      export interface Provider {
+        mode: 'filter';
+
+        values: Array<string>;
+      }
+    }
+  }
+
+  export interface Stripe {
+    authorization: string;
+
+    usage_events: Array<Stripe.UsageEvent>;
+  }
+
+  export namespace Stripe {
+    export interface UsageEvent {
+      payload: string;
+    }
+  }
+}
+
 export interface AIGatewayUpdateParams {
   /**
    * Path param

package/src/resources/ai-gateway/custom-providers.ts

@@ -13,7 +13,9 @@ export class BaseCustomProviders extends APIResource {
   ] as const);
 
   /**
-   * Creates a new AI Gateway.
+   * Creates an account-level custom provider that forwards AI Gateway requests to
+   * the HTTPS base URL you supply. Requests reference the provider as
+   * `custom-{slug}`, so the slug must be unique within the account.
    *
    * @example
    * ```ts
@@ -40,7 +42,8 @@ export class BaseCustomProviders extends APIResource {
   }
 
   /**
-   * Lists all AI Gateway evaluator types configured for the account.
+   * Lists the custom providers configured for the account, ordered by position and
+   * then name.
    *
    * @example
    * ```ts
@@ -65,7 +68,7 @@ export class BaseCustomProviders extends APIResource {
   }
 
   /**
-   * Deletes an AI Gateway dataset.
+   * Deletes a custom provider and every pricing rule that belongs to it.
    *
    * @example
    * ```ts
@@ -91,7 +94,7 @@ export class BaseCustomProviders extends APIResource {
   }
 
   /**
-   * Retrieves details for a specific AI Gateway dataset.
+   * Retrieves a custom provider, including its slug, base URL, and custom headers.
    *
    * @example
    * ```ts
@@ -142,6 +145,10 @@ export interface CustomProviderCreateResponse {
 
   enable?: boolean;
 
+  /**
+   * JSON object of extra HTTP headers that AI Gateway sends to the provider. Values
+   * can contain credentials.
+   */
   headers?: string;
 
   js_example?: string;
@@ -174,6 +181,10 @@ export interface CustomProviderListResponse {
 
   enable?: boolean;
 
+  /**
+   * JSON object of extra HTTP headers that AI Gateway sends to the provider. Values
+   * can contain credentials.
+   */
   headers?: string;
 
   js_example?: string;
@@ -206,6 +217,10 @@ export interface CustomProviderDeleteResponse {
 
   enable?: boolean;
 
+  /**
+   * JSON object of extra HTTP headers that AI Gateway sends to the provider. Values
+   * can contain credentials.
+   */
   headers?: string;
 
   js_example?: string;
@@ -238,6 +253,10 @@ export interface CustomProviderGetResponse {
 
   enable?: boolean;
 
+  /**
+   * JSON object of extra HTTP headers that AI Gateway sends to the provider. Values
+   * can contain credentials.
+   */
   headers?: string;
 
   js_example?: string;
@@ -291,7 +310,8 @@ export interface CustomProviderCreateParams {
   enable?: boolean;
 
   /**
-   * Body param
+   * Body param: JSON object of extra HTTP headers that AI Gateway sends to the
+   * provider. Values can contain credentials.
    */
   headers?: string;
 

package/src/resources/ai-gateway/datasets.ts

@@ -13,7 +13,9 @@ export class BaseDatasets extends APIResource {
   ] as const);
 
   /**
-   * Creates a new AI Gateway.
+   * Creates a dataset that selects gateway logs matching the specified filters for
+   * use in evaluations. Evaluations and datasets are deprecated and unavailable to
+   * new accounts.
    *
    * @example
    * ```ts
@@ -49,7 +51,8 @@ export class BaseDatasets extends APIResource {
   }
 
   /**
-   * Updates an existing AI Gateway dataset.
+   * Replaces the name, log filters, and enabled state of a dataset. Evaluations and
+   * datasets are deprecated and unavailable to new accounts.
    *
    * @example
    * ```ts
@@ -86,7 +89,8 @@ export class BaseDatasets extends APIResource {
   }
 
   /**
-   * Lists all AI Gateway evaluator types configured for the account.
+   * Lists the datasets defined for an AI Gateway. Evaluations and datasets are
+   * deprecated and unavailable to new accounts.
    *
    * @example
    * ```ts
@@ -113,7 +117,8 @@ export class BaseDatasets extends APIResource {
   }
 
   /**
-   * Deletes an AI Gateway dataset.
+   * Deletes a dataset. Evaluations and datasets are deprecated and unavailable to
+   * new accounts.
    *
    * @example
    * ```ts
@@ -141,7 +146,8 @@ export class BaseDatasets extends APIResource {
   }
 
   /**
-   * Retrieves details for a specific AI Gateway dataset.
+   * Retrieves a dataset and its log filters. Evaluations and datasets are deprecated
+   * and unavailable to new accounts.
    *
    * @example
    * ```ts
@@ -175,7 +181,7 @@ export interface DatasetCreateResponse {
   filters: Array<DatasetCreateResponse.Filter>;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 
@@ -217,7 +223,7 @@ export interface DatasetUpdateResponse {
   filters: Array<DatasetUpdateResponse.Filter>;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 
@@ -259,7 +265,7 @@ export interface DatasetListResponse {
   filters: Array<DatasetListResponse.Filter>;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 
@@ -301,7 +307,7 @@ export interface DatasetDeleteResponse {
   filters: Array<DatasetDeleteResponse.Filter>;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 
@@ -343,7 +349,7 @@ export interface DatasetGetResponse {
   filters: Array<DatasetGetResponse.Filter>;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 
@@ -427,7 +433,7 @@ export interface DatasetUpdateParams {
   account_id: string;
 
   /**
-   * Path param: gateway id
+   * Path param: Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 
@@ -496,7 +502,7 @@ export interface DatasetDeleteParams {
   account_id: string;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 }
@@ -505,7 +511,7 @@ export interface DatasetGetParams {
   account_id: string;
 
   /**
-   * gateway id
+   * Unique identifier of the AI Gateway within the account.
    */
   gateway_id: string;
 }

package/src/resources/ai-gateway/dynamic-routing.ts

@@ -12,7 +12,8 @@ export class BaseDynamicRouting extends APIResource {
   ] as const);
 
   /**
-   * Create a new AI Gateway Dynamic Route.
+   * Creates a dynamic route on an AI Gateway from the specified routing elements.
+   * Clients call the route by using `dynamic/{name}` as the model name.
    *
    * @example
    * ```ts
@@ -45,7 +46,8 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * Update an AI Gateway Dynamic Route.
+   * Updates the name of a dynamic route. To change routing behaviour, create and
+   * deploy a new version.
    *
    * @example
    * ```ts
@@ -70,7 +72,7 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * List all AI Gateway Dynamic Routes.
+   * Lists the dynamic routes configured on an AI Gateway.
    *
    * @example
    * ```ts
@@ -93,7 +95,7 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * Delete an AI Gateway Dynamic Route.
+   * Deletes a dynamic route from an AI Gateway.
    *
    * @example
    * ```ts
@@ -119,7 +121,8 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * Create a new AI Gateway Dynamic Route Deployment.
+   * Deploys the specified version of a dynamic route so that it serves traffic.
+   * Deploy an earlier version to roll back.
    *
    * @example
    * ```ts
@@ -149,7 +152,8 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * Create a new AI Gateway Dynamic Route Version.
+   * Creates a new version of a dynamic route from the specified routing elements.
+   * The version does not serve traffic until you deploy it.
    *
    * @example
    * ```ts
@@ -185,7 +189,8 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * Get an AI Gateway Dynamic Route.
+   * Retrieves a dynamic route with its routing elements, active version, and current
+   * deployment.
    *
    * @example
    * ```ts
@@ -211,7 +216,7 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * Get an AI Gateway Dynamic Route Version.
+   * Retrieves a saved version of a dynamic route, including its routing elements.
    *
    * @example
    * ```ts
@@ -241,7 +246,7 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * List all AI Gateway Dynamic Route Deployments.
+   * Lists the deployment history of a dynamic route.
    *
    * @example
    * ```ts
@@ -268,7 +273,7 @@ export class BaseDynamicRouting extends APIResource {
   }
 
   /**
-   * List all AI Gateway Dynamic Route Versions.
+   * Lists the saved versions of a dynamic route.
    *
    * @example
    * ```ts

package/src/resources/ai-gateway/evaluation-types.ts

@@ -12,7 +12,8 @@ export class BaseEvaluationTypes extends APIResource {
   ] as const);
 
   /**
-   * Lists all available evaluator types for scoring AI gateway responses.
+   * Lists the evaluator types that evaluations can use to score AI Gateway
+   * responses. Evaluations are deprecated and unavailable to new accounts.
    *
    * @example
    * ```ts