# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Intellectual Property (IP) Data Patents API
  version: 1.0.0
extends: openapi/clarivate-patents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/patents/document/abstract/availability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check patent abstract availability
      effect: read
      questions:
      - How do I check whether abstract journal entries exist for my patents and get download URLs?
      - Can I query abstract availability by publication number input type?
      instructions:
      - text: Check abstract availability for patents {patents}.
        slots:
          patents: requestBody.patents
      - text: Get abstract download URLs for {patents} in collection {collection}.
        slots:
          patents: requestBody.patents
          collection: requestBody.collection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/document/availability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check patent document availability
      effect: read
      questions:
      - How do I find out which patent full texts are available to download?
      - Can I get download URLs for a list of patents in one availability check?
      instructions:
      - text: Check document availability for patents {patents}.
        slots:
          patents: requestBody.patents
      - text: Get patent download URLs for {patents} using input type {input_type}.
        slots:
          patents: requestBody.patents
          input_type: requestBody.input_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/document/images/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List image URLs for a patent
      effect: read
      questions:
      - How do I get the images of a patent document from the IP data Patents API?
      - Can I list a patent's figure URLs by its GUID?
      instructions:
      - text: List image URLs for patent document {document_guid} in the Patents API.
        slots:
          document_guid: path.document_guid
      - text: Show the figures attached to patent GUID {document_guid}.
        slots:
          document_guid: path.document_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/document/json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several patent documents by GUID
      effect: read
      questions:
      - How do I retrieve multiple full patent documents in one call?
      - Can I restrict which fields come back for a batch of patents?
      instructions:
      - text: Fetch patent documents {GUIDS}.
        slots:
          GUIDS: requestBody.GUIDS
      - text: Get patents {GUIDS} returning only fields {FIELDS}.
        slots:
          GUIDS: requestBody.GUIDS
          FIELDS: requestBody.FIELDS
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/document/json/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one full patent document
      effect: read
      questions:
      - How do I pull the full JSON record of a single patent?
      - Can I get one patent document by its GUID?
      instructions:
      - text: Get patent document {document_guid} as JSON.
        slots:
          document_guid: path.document_guid
      - text: Show the full patent record for GUID {document_guid}.
        slots:
          document_guid: path.document_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/document/pdf/{document_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a patent PDF
      effect: read
      questions:
      - How do I download the PDF of a patent from the IP data Patents API?
      - Can I get a patent as a PDF file by GUID?
      instructions:
      - text: Download the PDF for patent {document_guid} from the Patents API.
        slots:
          document_guid: path.document_guid
      - text: Fetch patent {document_guid} as a PDF file.
        slots:
          document_guid: path.document_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/match_entity'].post
  update:
    x-apievangelist-phrasing:
      intent: Fuzzy-match several patent field values
      effect: read
      questions:
      - Can I fuzzy-match a batch of messy assignee names to canonical values?
      - How do I submit several values for fuzzy matching in one request?
      instructions:
      - text: Fuzzy-match these values {MATCH}.
        slots:
          MATCH: requestBody.MATCH
      - text: Run the match entity model over the batch {MATCH}.
        slots:
          MATCH: requestBody.MATCH
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/match_entity/{entity}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fuzzy-match one patent field value
      effect: read
      questions:
      - How do I find the canonical form of a single company name used in patents?
      - Can I look up one field value by fuzzy match with a simple GET?
      instructions:
      - text: Fuzzy-match the single value {entity}.
        slots:
          entity: path.entity
      - text: Find the closest known patent entity to {entity}.
        slots:
          entity: path.entity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/patents/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search and aggregate patents
      effect: read
      questions:
      - How do I search patents and aggregate the results by a field?
      - Can I sort and page patent search results?
      - What fields can I return from an analytic patent search?
      instructions:
      - text: Search patents for {QUERY}.
        slots:
          QUERY: requestBody.QUERY
      - text: Search patents matching {QUERY} ordered by {ORDERBY}, {LIMIT} per page from {OFFSET}.
        slots:
          QUERY: requestBody.QUERY
          ORDERBY: requestBody.ORDERBY
          LIMIT: requestBody.LIMIT
          OFFSET: requestBody.OFFSET
      method: generated
      generated: '2026-09-26'