cloudflare/src/resources/ai-security/ai-security.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as CustomTopicsAPI from './custom-topics';
import {
  BaseCustomTopics,
  CustomTopicGetParams,
  CustomTopicGetResponse,
  CustomTopicUpdateParams,
  CustomTopicUpdateResponse,
  CustomTopics,
} from './custom-topics';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class BaseAISecurity extends APIResource {
  static override readonly _key: readonly ['aiSecurity'] = Object.freeze(['aiSecurity'] as const);

  /**
   * Update the AI Security for Apps status for the zone, enabling or disabling the
   * detection. The detection results are exposed as `cf.llm.prompt.*` fields for use
   * in custom rules and rate limiting rules; changes can take up to a minute to
   * propagate.
   *
   * @example
   * ```ts
   * const aiSecurity = await client.aiSecurity.update({
   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   * });
   * ```
   */
  update(params: AISecurityUpdateParams, options?: RequestOptions): APIPromise<AISecurityUpdateResponse> {
    const { zone_id, ...body } = params;
    return (
      this._client.put(path`/zones/${zone_id}/ai-security/settings`, { body, ...options }) as APIPromise<{
        result: AISecurityUpdateResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Get the current AI Security for Apps status for the zone. While enabled,
   * Cloudflare scans prompts sent to endpoints labeled `cf-llm` for personally
   * identifiable information, unsafe topics, and prompt injection attempts.
   *
   * @example
   * ```ts
   * const aiSecurity = await client.aiSecurity.get({
   *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
   * });
   * ```
   */
  get(params: AISecurityGetParams, options?: RequestOptions): APIPromise<AISecurityGetResponse> {
    const { zone_id } = params;
    return (
      this._client.get(path`/zones/${zone_id}/ai-security/settings`, options) as APIPromise<{
        result: AISecurityGetResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class AISecurity extends BaseAISecurity {
  customTopics: CustomTopicsAPI.CustomTopics = new CustomTopicsAPI.CustomTopics(this._client);
}

/**
 * AI Security for Apps enablement status for a zone.
 */
export interface AISecurityUpdateResponse {
  /**
   * Whether AI Security for Apps is enabled on the zone.
   */
  enabled?: boolean;
}

/**
 * AI Security for Apps enablement status for a zone.
 */
export interface AISecurityGetResponse {
  /**
   * Whether AI Security for Apps is enabled on the zone.
   */
  enabled?: boolean;
}

export interface AISecurityUpdateParams {
  /**
   * Path param: Defines the zone.
   */
  zone_id: string;

  /**
   * Body param: Whether AI Security for Apps is enabled on the zone.
   */
  enabled?: boolean;
}

export interface AISecurityGetParams {
  /**
   * Defines the zone.
   */
  zone_id: string;
}

AISecurity.CustomTopics = CustomTopics;
AISecurity.BaseCustomTopics = BaseCustomTopics;

export declare namespace AISecurity {
  export {
    type AISecurityUpdateResponse as AISecurityUpdateResponse,
    type AISecurityGetResponse as AISecurityGetResponse,
    type AISecurityUpdateParams as AISecurityUpdateParams,
    type AISecurityGetParams as AISecurityGetParams,
  };

  export {
    CustomTopics as CustomTopics,
    BaseCustomTopics as BaseCustomTopics,
    type CustomTopicUpdateResponse as CustomTopicUpdateResponse,
    type CustomTopicGetResponse as CustomTopicGetResponse,
    type CustomTopicUpdateParams as CustomTopicUpdateParams,
    type CustomTopicGetParams as CustomTopicGetParams,
  };
}