# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dialogflow CX API (v3) - Conversational Agents Security…
  version: 1.0.0
extends: openapi/google-dialogflow-security-settings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/securitySettings'].get
  update:
    x-apievangelist-phrasing:
      intent: List security settings in a location
      effect: read
      questions:
      - Which Dialogflow CX security settings profiles exist in my project and region?
      - Can I page through all security settings in a location?
      instructions:
      - text: List security settings in project {project}, location {location}.
        slots:
          project: path.projectsId
          location: path.locationsId
      - text: Show {page_size} security settings per page in {location}.
        slots:
          page_size: query.pageSize
          location: path.locationsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/securitySettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create security settings for redaction and retention
      effect: write
      questions:
      - How do I make my conversational agents redact sensitive data from logs?
      - Can I set how many days conversation data is retained before it is purged?
      instructions:
      - text: Create security settings {display_name} in project {project}, location {location} with a {days}-day retention window.
        slots:
          display_name: requestBody.displayName
          project: path.projectsId
          location: path.locationsId
          days: requestBody.retentionWindowDays
      - text: Add security settings {display_name} using inspect template {inspect_template} and redaction strategy {strategy}.
        slots:
          display_name: requestBody.displayName
          inspect_template: requestBody.inspectTemplate
          strategy: requestBody.redactionStrategy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve security settings
      effect: read
      questions:
      - What redaction and retention rules does a security settings profile apply?
      - Can I view one security settings resource by ID?
      instructions:
      - text: Get security settings {settings} in project {project}, location {location}.
        slots:
          settings: path.securitySettingsId
          project: path.projectsId
          location: path.locationsId
      - text: Show the redaction and retention configuration of {settings}.
        slots:
          settings: path.securitySettingsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete security settings
      effect: destructive
      questions:
      - Can I delete a security settings profile no agent uses anymore?
      - Is removing security settings done by its ID?
      instructions:
      - text: Delete security settings {settings} in project {project}, location {location}.
        slots:
          settings: path.securitySettingsId
          project: path.projectsId
          location: path.locationsId
      - text: Remove the security settings profile {settings}.
        slots:
          settings: path.securitySettingsId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update security settings
      effect: write
      questions:
      - How do I shorten the retention period on existing security settings?
      - Can I change which data types get purged or how audio is exported?
      instructions:
      - text: Change the retention window of security settings {settings} in project {project}, location {location} to {days} days.
        slots:
          settings: path.securitySettingsId
          project: path.projectsId
          location: path.locationsId
          days: requestBody.retentionWindowDays
      - text: Set purge data types {purge_types} on security settings {settings}.
        slots:
          purge_types: requestBody.purgeDataTypes
          settings: path.securitySettingsId
      method: generated
      generated: '2026-10-01'