Cloudmersive Analyze API

openapi: 3.2.0
info:
  title: Document AI Analyze API
  description: Extract structured data including named fields, tables, barcodes, classifications, and summaries from common document formats, scanned documents, and photos of documents using AI. Also supports handwriting and low quality photos and scans, as well as digital document input. Supports a wide range of languages, and is able to analyze and infer semantic structure from the visual layout for documents.
  termsOfService: https://portal.cloudmersive.com/terms-of-service
  contact:
    name: Cloudmersive
    url: https://www.cloudmersive.com
    email: support@cloudmersive.com
  version: v1
servers:
- url: https://api.cloudmersive.com
security:
- Apikey: []
tags:
- name: Analyze
paths:
  /document-ai/document/analyze/enforce-policy:
    post:
      tags:
      - Analyze
      summary: Enforce Policies to a Document to allow or block it using Advanced AI
      description: Enforce Policies to a Document to allow or block it using Advanced AI. Input document formats supported include DOCX, PDF, PNG and JPG. Consumes 100 API calls per page.
      operationId: ApplyRules
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentPolicyResult'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentPolicyResult'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentPolicyResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentPolicyRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DocumentPolicyRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DocumentPolicyRequest'
        description: Input request, including document and policy rules
  /document-ai/document/analyze/answer-questions:
    post:
      tags:
      - Analyze
      summary: Answer Questions about a Document in a structured way using Advanced AI
      description: Answer boolean (yes/no), multiple-choice and free-response questions about the contents of a document using Advanced AI. Input document formats supported include DOCX, PDF, PNG and JPG. Consumes 100 API calls per page.
      operationId: AnswerQuestions
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DocumentQuestionAnswersResult'
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentQuestionAnswersResult'
            text/json:
              schema:
                $ref: '#/components/schemas/DocumentQuestionAnswersResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentQuestionsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DocumentQuestionsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DocumentQuestionsRequest'
        description: Input request, including document and questions
components:
  schemas:
    DocumentQuestionChoiceItem:
      description: Possible response choice for a multiple-choice question
      type: object
      properties:
        ChoiceId:
          description: Unique ID of the response choice, e.g. 3C
          type: string
        ChoiceText:
          description: Description text of this choice, e.g. 'Delaware'
          type: string
      additionalProperties: false
    DocumentPolicyRequest:
      description: Request to analyze a document
      type: object
      properties:
        InputFile:
          format: byte
          description: Input file as a byte array
          type: string
        Rules:
          description: Rules to apply to the document
          type: array
          items:
            $ref: '#/components/schemas/PolicyRule'
        RecognitionMode:
          description: Optional; Recognition mode - Normal (default) provides the highest accuracy but slower speed, FastPlus provides even faster processing at somewhat reduced accuracy, Fast provides faster processing at reduced accuracy, and FastMini provides the fastest processing at significantly reduced accuracy
          type: string
      additionalProperties: false
    DocumentPolicyResult:
      description: Result of performing a document policy enforcement operation
      type: object
      properties:
        CleanResult:
          description: True if the document complies with all of the policies, and false if it does not
          type: boolean
        RiskScore:
          format: double
          description: Risk score between 0.0 and 1.0 where values above 0.5 are increasing levels of risk
          type: number
        RuleViolations:
          description: Policy violations
          type: array
          items:
            $ref: '#/components/schemas/PolicyRuleViolation'
      additionalProperties: false
    DocumentQuestionAnswerItem:
      description: Answer to an input question
      type: object
      properties:
        QuestionId:
          description: ID of the input question
          type: string
        AnswerValue:
          description: Answer response value, formatted as a string, for this question.  Boolean questions will return YES or NO.
          type: string
        AnswerRationale:
          description: Rationale explaining why this answer was given
          type: string
        ConfidenceScore:
          format: double
          description: Confidence score between 0.0 and 1.0 where values above 0.8 indicate high confidence
          type: number
      additionalProperties: false
    DocumentQuestionAnswersResult:
      description: Result of performing a document question answering operation
      type: object
      properties:
        Successful:
          description: True if the operation was completed successfully, or false otherwise
          type: boolean
        ConfidenceScore:
          format: double
          description: Confidence score between 0.0 and 1.0 where values above 0.8 indicate high confidence
          type: number
        AnswerResults:
          type: array
          items:
            $ref: '#/components/schemas/DocumentQuestionAnswerItem'
      additionalProperties: false
    DocumentQuestionFreeResponse:
      description: Free response question
      type: object
      properties:
        QuestionId:
          description: Unique ID of the question, e.g. 7 or 5A
          type: string
        QuestionText:
          description: Question in natural language to ask of the document where the answer resolves to a free response, e.g. 'Who is the counterparty in this agreement?'
          type: string
      additionalProperties: false
    PolicyRuleViolation:
      description: Instances of a policy rule violation
      type: object
      properties:
        RuleId:
          description: ID of the rule; if no ID was supplied, the ID is the 1-based index of the rule
          type: string
        RuleViolationRiskScore:
          format: double
          description: Risk score between 0.0 and 1.0 where values above 0.5 are increasing levels of risk
          type: number
        RuleViolationRationale:
          description: AI natural language rationale for why this policy was violated
          type: string
      additionalProperties: false
    DocumentQuestionMultipleChoice:
      description: Multiple choice question
      type: object
      properties:
        QuestionId:
          description: Unique ID of the question, e.g. 1 or 2A
          type: string
        QuestionText:
          description: Question in natural language to ask of the document where the answer resolves to one of a fixed number of provided choices, e.g. 'What is the governing law of this agreement?'
          type: string
        ResponseChoices:
          description: Possible response choices for the multiple-choice question
          type: array
          items:
            $ref: '#/components/schemas/DocumentQuestionChoiceItem'
      additionalProperties: false
    DocumentQuestionBoolean:
      description: Boolean document question
      type: object
      properties:
        QuestionId:
          description: Unique ID of the question, e.g. 1 or 2A
          type: string
        QuestionText:
          description: Question in natural language to ask of the document where the answer resolves to YES or NO, e.g. 'Is this document signed and countersigned by both parties?'
          type: string
      additionalProperties: false
    PolicyRule:
      type: object
      properties:
        RuleId:
          description: ''
          type: string
        RuleType:
          description: Possible values are ALLOW and DENY
          type: string
        RuleDescription:
          description: Description of the rule in natural language, e.g. Do not allow documents that contain offensive language
          type: string
      additionalProperties: false
    DocumentQuestionsRequest:
      type: object
      properties:
        InputFile:
          format: byte
          description: Input file as a byte array
          type: string
        QuestionsYesNo:
          description: 'Optional: Yes or No boolean questions to answer about the document'
          type: array
          items:
            $ref: '#/components/schemas/DocumentQuestionBoolean'
        QuestionsMultipleChoice:
          description: 'Optional: Multiple choice questions to answer about the document'
          type: array
          items:
            $ref: '#/components/schemas/DocumentQuestionMultipleChoice'
        QuestionsFreeResponse:
          description: 'Optional: Free response questions to answer about the document'
          type: array
          items:
            $ref: '#/components/schemas/DocumentQuestionFreeResponse'
        RecognitionMode:
          description: Optional; Recognition mode - Normal (default) provides the highest accuracy but slower speed, FastPlus provides even faster processing at somewhat reduced accuracy, Fast provides faster processing at reduced accuracy, and FastMini provides the fastest processing at significantly reduced accuracy
          type: string
      additionalProperties: false
  securitySchemes:
    Apikey:
      type: apiKey
      name: Apikey
      in: header
      description: API Key Authentication
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/document-ai/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)