API Evangelist conversational phrasing for X-Author Intelligent Import API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for X-Author Intelligent Import API
  version: 1.0.0
extends: openapi/conga-intelligentimport-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['/api/xauthor/v1/intelligent-imports/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract data from a contract document
      effect: write
      questions:
      - How do I extract terms from an uploaded agreement document?
      - Can intelligent import read a specific attachment?
      instructions:
      - text: Extract attachment {attachment} on agreement {agreement}.
        slots:
          attachment: requestBody.attachmentId
          agreement: requestBody.agreementId
      - text: Run intelligent import on file {name} for agreement {agreement}.
        slots:
          name: requestBody.attachmentName
          agreement: requestBody.agreementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/documents/mark-clauses-and-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract and mark clauses and fields
      effect: write
      questions:
      - Can intelligent import mark the clauses and fields it finds in a document?
      - How do I auto-tag clauses in an imported contract?
      instructions:
      - text: Extract and mark clauses and fields in attachment {attachment} of agreement {agreement}.
        slots:
          attachment: requestBody.attachmentId
          agreement: requestBody.agreementId
      - text: Mark clauses and fields for extraction job {job}.
        slots:
          job: requestBody.ideJobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/documents/retrieve-properties/{contractId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get extracted field and clause properties
      effect: read
      questions:
      - What field and clause properties were extracted for a contract?
      - Can I retrieve detected dates from an imported document?
      instructions:
      - text: Get extracted field and clause properties for contract {contract}.
        slots:
          contract: path.contractId
      - text: Retrieve properties for contract {contract} from extracted fields {fields}.
        slots:
          contract: path.contractId
          fields: requestBody.ideExtractedFieldData
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/documents/status/{contractId}/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check document extraction status
      effect: read
      questions:
      - Has extraction finished for a contract document?
      - How do I check document extraction progress for an attachment?
      instructions:
      - text: Check extraction status of attachment {attachment} on contract {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractId
      - text: Show document extraction progress for {attachment} in {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/intelligent-imports/jobs/status/{contractId}/{attachmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check intelligent import job status
      effect: read
      questions:
      - What is the status of the IDE job for an attachment?
      - Is the intelligent import job still running?
      instructions:
      - text: Get the IDE job status for attachment {attachment} on contract {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractId
      - text: Check the import job running on {attachment} of {contract}.
        slots:
          attachment: path.attachmentId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'