openapi: 3.0.3
info:
  title: Phedone
  description: ''
  version: 1.0.0
servers:
  -
    url: 'http://diabolocom-ai.local'
paths:
  /api/informations:
    get:
      summary: ''
      operationId: getApiInformations
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    name: 'Dolor nemo quia vel in. Sunt labore debitis velit. Amet et vero nulla repudiandae perspiciatis.'
                    account:
                      email: marine11@example.net
                      name: 'Michèle Bonneau'
                properties:
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                        example: 'Dolor nemo quia vel in. Sunt labore debitis velit. Amet et vero nulla repudiandae perspiciatis.'
                      account:
                        type: object
                        properties:
                          email:
                            type: string
                            example: marine11@example.net
                          name:
                            type: string
                            example: 'Michèle Bonneau'
      tags:
        - 'Account/User Management Endpoints'
      security: []
  /api/buckets:
    get:
      summary: ''
      operationId: getApiBuckets
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: b1ee4370-9b56-4b87-8eb8-dee59919eb52
                      title: 'Accusantium voluptatem adipisci consequatur repellat qui ipsa.'
                      created_at: 918479857
                      entries_count: 1
                      webhooks:
                        enabled: false
                        link: null
                        signing_enabled: false
                        secret: null
                    -
                      id: bf44cebf-498c-4cea-90f5-6bdeafb8e375
                      title: 'Saepe ducimus tempore adipisci.'
                      created_at: 530915054
                      entries_count: 1
                      webhooks:
                        enabled: false
                        link: null
                        signing_enabled: false
                        secret: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: b1ee4370-9b56-4b87-8eb8-dee59919eb52
                        title: 'Accusantium voluptatem adipisci consequatur repellat qui ipsa.'
                        created_at: 918479857
                        entries_count: 1
                        webhooks:
                          enabled: false
                          link: null
                          signing_enabled: false
                          secret: null
                      -
                        id: bf44cebf-498c-4cea-90f5-6bdeafb8e375
                        title: 'Saepe ducimus tempore adipisci.'
                        created_at: 530915054
                        entries_count: 1
                        webhooks:
                          enabled: false
                          link: null
                          signing_enabled: false
                          secret: null
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: b1ee4370-9b56-4b87-8eb8-dee59919eb52
                        title:
                          type: string
                          example: 'Accusantium voluptatem adipisci consequatur repellat qui ipsa.'
                        created_at:
                          type: integer
                          example: 918479857
                        entries_count:
                          type: integer
                          example: 1
                        webhooks:
                          type: object
                          properties:
                            enabled:
                              type: boolean
                              example: false
                            link:
                              type: string
                              example: null
                            signing_enabled:
                              type: boolean
                              example: false
                            secret:
                              type: string
                              example: null
      tags:
        - 'Databuckets Endpoints'
      security: []
    post:
      summary: ''
      operationId: postApiBuckets
      description: ''
      parameters: []
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  id: id_of_new_databucket
                properties:
                  id:
                    type: string
                    example: id_of_new_databucket
      tags:
        - 'Databuckets Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: 'Must not be greater than 255 characters.'
                  example: nwuyaejs
                webhooks_enabled:
                  type: boolean
                  description: ''
                  example: false
                webhooks_signing_enabled:
                  type: boolean
                  description: 'This field is required when <code>webhooks_enabled</code> is <code>true</code>.'
                  example: true
              required:
                - title
      security: []
  '/api/buckets/{dataBucket}/entries':
    post:
      summary: ''
      operationId: postApiBucketsDataBucketEntries
      description: ''
      parameters: []
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  added_entries: 5
                properties:
                  added_entries:
                    type: integer
                    example: 5
      tags:
        - 'Databuckets Endpoints'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  type: string
                  description: 'Le texte value doit contenir au moins 1 caractères. Le texte de value ne peut contenir plus de 10000 caractères.'
                  example: xntefluuqhngztgiv
                meta:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                classifications:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                entries:
                  type: array
                  description: 'Le tableau value ne peut contenir plus de 50 éléments.'
                  example: jlpuyh
                  items:
                    type: string
      security: []
    get:
      summary: ''
      operationId: getApiBucketsDataBucketEntries
      description: ''
      parameters:
        -
          in: query
          name: page
          description: ''
          example: 1
          required: false
          schema:
            type: string
            description: ''
            example: 1
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      content: 'Sit aut et fuga tempora sunt totam perferendis repellendus iusto perferendis fugiat iusto eligendi quia rem culpa vitae voluptate expedita qui modi amet placeat voluptatem aut assumenda ut cupiditate ut laboriosam fugit quod autem aut.'
                      meta: []
                      classifications: []
                      created_at: 1725140019
                      results:
                        -
                          id: 225a9257-7f4d-4234-9ca2-135c33d914ea
                          textual_result: "Si Madame veut me faire l'honneur d'en user, dit le."
                          numeric_result: 1
                    -
                      content: 'Sequi alias minus temporibus dolor et et amet reiciendis ipsam harum sint non dolorum omnis aut rem ducimus consectetur et quod rem eaque cupiditate provident numquam consequatur consequatur provident quia fugiat praesentium.'
                      meta: []
                      classifications: []
                      created_at: 1118778332
                      results:
                        -
                          id: b4d5ed30-d86f-41c9-96a9-f57d1c43acad
                          textual_result: 'Charles Bovary, se fit un devoir de prodiguer au médecin.'
                          numeric_result: 5
                  links:
                    first: '/?page=1'
                    last: '/?page=1'
                    prev: null
                    next: null
                  meta:
                    current_page: 1
                    from: 1
                    last_page: 1
                    links:
                      -
                        url: null
                        label: '&laquo; Previous'
                        active: false
                      -
                        url: '/?page=1'
                        label: '1'
                        active: true
                      -
                        url: null
                        label: 'Next &raquo;'
                        active: false
                    path: /
                    per_page: 15
                    to: 2
                    total: 2
                properties:
                  data:
                    type: array
                    example:
                      -
                        content: 'Sit aut et fuga tempora sunt totam perferendis repellendus iusto perferendis fugiat iusto eligendi quia rem culpa vitae voluptate expedita qui modi amet placeat voluptatem aut assumenda ut cupiditate ut laboriosam fugit quod autem aut.'
                        meta: []
                        classifications: []
                        created_at: 1725140019
                        results:
                          -
                            id: 225a9257-7f4d-4234-9ca2-135c33d914ea
                            textual_result: "Si Madame veut me faire l'honneur d'en user, dit le."
                            numeric_result: 1
                      -
                        content: 'Sequi alias minus temporibus dolor et et amet reiciendis ipsam harum sint non dolorum omnis aut rem ducimus consectetur et quod rem eaque cupiditate provident numquam consequatur consequatur provident quia fugiat praesentium.'
                        meta: []
                        classifications: []
                        created_at: 1118778332
                        results:
                          -
                            id: b4d5ed30-d86f-41c9-96a9-f57d1c43acad
                            textual_result: 'Charles Bovary, se fit un devoir de prodiguer au médecin.'
                            numeric_result: 5
                    items:
                      type: object
                      properties:
                        content:
                          type: string
                          example: 'Sit aut et fuga tempora sunt totam perferendis repellendus iusto perferendis fugiat iusto eligendi quia rem culpa vitae voluptate expedita qui modi amet placeat voluptatem aut assumenda ut cupiditate ut laboriosam fugit quod autem aut.'
                        meta:
                          type: array
                          example: []
                        classifications:
                          type: array
                          example: []
                        created_at:
                          type: integer
                          example: 1725140019
                        results:
                          type: array
                          example:
                            -
                              id: 225a9257-7f4d-4234-9ca2-135c33d914ea
                              textual_result: "Si Madame veut me faire l'honneur d'en user, dit le."
                              numeric_result: 1
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                example: 225a9257-7f4d-4234-9ca2-135c33d914ea
                              textual_result:
                                type: string
                                example: "Si Madame veut me faire l'honneur d'en user, dit le."
                              numeric_result:
                                type: integer
                                example: 1
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: '/?page=1'
                      last:
                        type: string
                        example: '/?page=1'
                      prev:
                        type: string
                        example: null
                      next:
                        type: string
                        example: null
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      last_page:
                        type: integer
                        example: 1
                      links:
                        type: array
                        example:
                          -
                            url: null
                            label: '&laquo; Previous'
                            active: false
                          -
                            url: '/?page=1'
                            label: '1'
                            active: true
                          -
                            url: null
                            label: 'Next &raquo;'
                            active: false
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              example: null
                            label:
                              type: string
                              example: '&laquo; Previous'
                            active:
                              type: boolean
                              example: false
                      path:
                        type: string
                        example: /
                      per_page:
                        type: integer
                        example: 15
                      to:
                        type: integer
                        example: 2
                      total:
                        type: integer
                        example: 2
      tags:
        - 'Databuckets Endpoints'
      security: []
    parameters:
      -
        in: path
        name: dataBucket
        description: ''
        example: pariatur
        required: true
        schema:
          type: string
  /api/job/tasks:
    post:
      summary: ''
      operationId: postApiJobTasks
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  job_id: some-job-id
                  job_status_endpoint_url: 'http://urltogetstatusendpoint.com'
                  audio_id: id-of-phone-call
                properties:
                  job_id:
                    type: string
                    example: some-job-id
                  job_status_endpoint_url:
                    type: string
                    example: 'http://urltogetstatusendpoint.com'
                  audio_id:
                    type: string
                    example: id-of-phone-call
        403:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'You are not allowed to use this endpoint, please contact our sales team to get access'
                properties:
                  message:
                    type: string
                    example: 'You are not allowed to use this endpoint, please contact our sales team to get access'
      tags:
        - 'Inference Endpoints'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                original_call_id:
                  type: string
                  description: ''
                  example: hic
                task:
                  type: string
                  description: ''
                  example: ai-insight
                  enum:
                    - transcription
                    - ai-insight
                    - transcription-to-ai-insight
                job_id:
                  type: string
                  description: ''
                  example: sed
                results_webhook_callback_url:
                  type: string
                  description: 'Must be a valid URL.'
                  example: 'http://kovacek.biz/nostrum-cum-vel-magnam-numquam-maiores-cupiditate-eos'
                keep_audio_after_analysis:
                  type: boolean
                  description: ''
                  example: true
                configuration:
                  type: object
                  description: 'This field is required when <code>job_id</code> is not present.'
                  example: null
                  properties:
                    vocabulary:
                      type: string
                      description: 'This field is required when <code>job_id</code> is not present. Le texte de value ne peut contenir plus de 300 caractères.'
                      example: owpwcxo
                    company_name:
                      type: string
                      description: 'This field is required when <code>job_id</code> is not present. Le texte de value ne peut contenir plus de 50 caractères.'
                      example: nllyyrbwrgdclkgvqgom
                    asr:
                      type: object
                      description: ''
                      example: null
                      properties:
                        prompt:
                          type: string
                          description: 'Le texte de value ne peut contenir plus de 400 caractères.'
                          example: atjucfjfrfisxzrqvtwqnyqk
                        lang:
                          type: string
                          description: ''
                          example: et
                        segments_to_crop:
                          type: array
                          description: ''
                          example:
                            - repellat
                          items:
                            type: integer
                    insights:
                      type: object
                      description: ''
                      example: null
                      properties:
                        tasks_parameters:
                          type: object
                          description: ''
                          example: null
                          properties: {  }
                        output_lang:
                          type: string
                          description: ''
                          example: consequatur
                file:
                  type: string
                  format: binary
                  description: 'This field is required when none of <code>job_id</code>, <code>base_64_file</code>, and <code>diabolocom_call_id</code> are present.  Must be a file. La taille du fichier de value ne peut pas dépasser 61440 kilo-octets.'
                base_64_file:
                  type: string
                  description: 'This field is required when none of <code>job_id</code>, <code>file</code>, and <code>diabolocom_call_id</code> are present.'
                  example: explicabo
                diabolocom_call_id:
                  type: string
                  description: 'This field is required when none of <code>job_id</code>, <code>base_64_file</code>, and <code>file</code> are present.'
                  example: aut
                voicemail:
                  type: boolean
                  description: ''
                  example: true
                generate_tags_with_summary:
                  type: boolean
                  description: ''
                  example: false
                insight_task:
                  type: string
                  description: 'This field is required when none of <code>insight_tasks</code> and <code>insights_preset_chain</code> are present.'
                  example: actions-extraction
                  enum:
                    - call-reason-extraction
                    - actions-extraction
                    - sequencing
                    - summarization
                    - nps-estimation
                    - quality-monitoring-criteria-evaluation
                    - quality-monitoring-criterion-generation
                    - contact-reason-classification
                    - email-multiclass-tagging
                    - knowledge-based-question-answering
                    - language-detection
                    - rating-estimation
                    - email-addresses-extraction
                    - products-extraction
                    - monetary-values-extraction
                    - locations-extraction
                    - names-extraction
                    - touchpoints-extraction
                    - phone-numbers-extraction
                    - satisfaction-factors
                insight_tasks:
                  type: array
                  description: ''
                  example:
                    - products-extraction
                  items:
                    type: string
                    enum:
                      - call-reason-extraction
                      - actions-extraction
                      - sequencing
                      - summarization
                      - nps-estimation
                      - quality-monitoring-criteria-evaluation
                      - quality-monitoring-criterion-generation
                      - contact-reason-classification
                      - email-multiclass-tagging
                      - knowledge-based-question-answering
                      - language-detection
                      - rating-estimation
                      - email-addresses-extraction
                      - products-extraction
                      - monetary-values-extraction
                      - locations-extraction
                      - names-extraction
                      - touchpoints-extraction
                      - phone-numbers-extraction
                      - satisfaction-factors
                insights_preset_chain:
                  type: string
                  description: 'This field is required when none of <code>insight_task</code> and <code>insight_tasks</code> are present.'
                  example: qm-criteria-evaluation
                  enum:
                    - all-on-shelf
                    - essentials
                    - simple
                    - carrefour-complete-collection
                    - qm-criteria-evaluation
                meta:
                  type: array
                  description: ''
                  example:
                    - adipisci
                  items:
                    type: string
              required:
                - task
      security: []
  /api/job/text-tasks:
    post:
      summary: ''
      operationId: postApiJobTextTasks
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Inference Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                configuration:
                  type: object
                  description: ''
                  example: []
                  properties:
                    input_parameters:
                      type: object
                      description: ''
                      example: []
                      properties: {  }
                meta:
                  type: array
                  description: ''
                  example:
                    - saepe
                  items:
                    type: string
                output_lang:
                  type: string
                  description: ''
                  example: quos
                task:
                  type: string
                  description: 'This field is required when <code>tasks</code> is not present.'
                  example: quality-monitoring-criterion-generation
                  enum:
                    - quality-monitoring-criterion-generation
                    - email-multiclass-tagging
                    - contact-reason-classification
                    - knowledge-based-question-answering
                    - language-detection
                    - rating-estimation
                    - email-addresses-extraction
                    - products-extraction
                    - monetary-values-extraction
                    - locations-extraction
                    - names-extraction
                    - touchpoints-extraction
                    - phone-numbers-extraction
                    - satisfaction-factors
                tasks:
                  type: array
                  description: ''
                  example:
                    - email-addresses-extraction
                  items:
                    type: string
                    enum:
                      - quality-monitoring-criterion-generation
                      - email-multiclass-tagging
                      - contact-reason-classification
                      - knowledge-based-question-answering
                      - language-detection
                      - rating-estimation
                      - email-addresses-extraction
                      - products-extraction
                      - monetary-values-extraction
                      - locations-extraction
                      - names-extraction
                      - touchpoints-extraction
                      - phone-numbers-extraction
                      - satisfaction-factors
              required:
                - configuration
      security: []
  '/api/job/status/{job_id}':
    get:
      summary: ''
      operationId: getApiJobStatusJob_id
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: 78a61c25-ea99-486c-bda9-35bbbd0d09c6
                    original_call_id: 0b45ccdf-e936-338f-8595-7d4cb6e18ff3
                    audio_id: 0a70debe-9c33-4e00-85e0-90848ace3a76
                    status: success
                    results:
                      audio:
                        duration: 674
                      ai-insights:
                        llm-title:
                          -
                            id: afe31d73-6103-4229-a1ab-447feaaae876
                            text: 'Facere iusto est quaerat rerum dolores est et. Officiis explicabo laboriosam minima repellendus voluptatibus distinctio accusamus nulla. Saepe minima expedita omnis.'
                            object: []
                            type: llm-title
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 78a61c25-ea99-486c-bda9-35bbbd0d09c6
                      original_call_id:
                        type: string
                        example: 0b45ccdf-e936-338f-8595-7d4cb6e18ff3
                      audio_id:
                        type: string
                        example: 0a70debe-9c33-4e00-85e0-90848ace3a76
                      status:
                        type: string
                        example: success
                      results:
                        type: object
                        properties:
                          audio:
                            type: object
                            properties:
                              duration:
                                type: integer
                                example: 674
                          ai-insights:
                            type: object
                            properties:
                              llm-title:
                                type: array
                                example:
                                  -
                                    id: afe31d73-6103-4229-a1ab-447feaaae876
                                    text: 'Facere iusto est quaerat rerum dolores est et. Officiis explicabo laboriosam minima repellendus voluptatibus distinctio accusamus nulla. Saepe minima expedita omnis.'
                                    object: []
                                    type: llm-title
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                      example: afe31d73-6103-4229-a1ab-447feaaae876
                                    text:
                                      type: string
                                      example: 'Facere iusto est quaerat rerum dolores est et. Officiis explicabo laboriosam minima repellendus voluptatibus distinctio accusamus nulla. Saepe minima expedita omnis.'
                                    object:
                                      type: array
                                      example: []
                                    type:
                                      type: string
                                      example: llm-title
      tags:
        - 'Inference Endpoints'
      security: []
    parameters:
      -
        in: path
        name: job_id
        description: 'The ID of the job.'
        example: 78a61c25-ea99-486c-bda9-35bbbd0d09c6
        required: true
        schema:
          type: string
  /api/models/advanced_entity_recognition:
    post:
      summary: ''
      operationId: postApiModelsAdvanced_entity_recognition
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: id
                text:
                  type: string
                  description: ''
                  example: nihil
                entities:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                data_bucket_id:
                  type: string
                  description: ''
                  example: et
              required:
                - text
      security: []
  /api/models/contact_reason:
    post:
      summary: ''
      operationId: postApiModelsContact_reason
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 4000 caractères.'
                  example: ayrmuaywzfjlnjmlvcqx
                tags:
                  type: array
                  description: ''
                  example:
                    - at
                  items:
                    type: string
                data_bucket_id:
                  type: string
                  description: ''
                  example: dolor
              required:
                - text
                - tags
      security: []
  '/api/models/custom_models_runner/{training_id}':
    post:
      summary: ''
      operationId: postApiModelsCustom_models_runnerTraining_id
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: ''
                  example: rerum
                data_bucket_id:
                  type: string
                  description: ''
                  example: illo
              required:
                - text
      security: []
    parameters:
      -
        in: path
        name: training_id
        description: 'The ID of the training.'
        example: architecto
        required: true
        schema:
          type: string
  /api/models/diabolocom_ai_insight:
    post:
      summary: ''
      operationId: postApiModelsDiabolocom_ai_insight
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: ''
                  example: qui
                data_bucket_id:
                  type: string
                  description: ''
                  example: ex
              required:
                - text
      security: []
  /api/models/entity_recognition:
    post:
      summary: ''
      operationId: postApiModelsEntity_recognition
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: quisquam
                text:
                  type: string
                  description: ''
                  example: dolor
                entities:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                data_bucket_id:
                  type: string
                  description: ''
                  example: dolores
              required:
                - lang
                - text
      security: []
  /api/models/extract_advanced_persons:
    post:
      summary: ''
      operationId: postApiModelsExtract_advanced_persons
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: rerum
                text:
                  type: string
                  description: ''
                  example: ipsum
                data_bucket_id:
                  type: string
                  description: ''
                  example: magnam
              required:
                - text
      security: []
  /api/models/extract_currencies:
    post:
      summary: ''
      operationId: postApiModelsExtract_currencies
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: exercitationem
                text:
                  type: string
                  description: ''
                  example: sapiente
                data_bucket_id:
                  type: string
                  description: ''
                  example: repudiandae
              required:
                - text
      security: []
  /api/models/extract_emails:
    post:
      summary: ''
      operationId: postApiModelsExtract_emails
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: ab
                text:
                  type: string
                  description: ''
                  example: unde
                data_bucket_id:
                  type: string
                  description: ''
                  example: ad
              required:
                - text
      security: []
  /api/models/extract_languages:
    post:
      summary: ''
      operationId: postApiModelsExtract_languages
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 4000 caractères.'
                  example: vftackazrxmvobrtpcyuspwag
                data_bucket_id:
                  type: string
                  description: ''
                  example: rem
              required:
                - text
      security: []
  /api/models/extract_locations:
    post:
      summary: ''
      operationId: postApiModelsExtract_locations
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: corrupti
                text:
                  type: string
                  description: ''
                  example: voluptatibus
                data_bucket_id:
                  type: string
                  description: ''
                  example: eum
              required:
                - text
      security: []
  /api/models/extract_persons:
    post:
      summary: ''
      operationId: postApiModelsExtract_persons
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: laborum
                text:
                  type: string
                  description: ''
                  example: et
                data_bucket_id:
                  type: string
                  description: ''
                  example: veniam
              required:
                - text
      security: []
  /api/models/extract_phones:
    post:
      summary: ''
      operationId: postApiModelsExtract_phones
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: ullam
                text:
                  type: string
                  description: ''
                  example: aspernatur
                data_bucket_id:
                  type: string
                  description: ''
                  example: aut
              required:
                - text
      security: []
  /api/models/fine_entity_recognition:
    post:
      summary: ''
      operationId: postApiModelsFine_entity_recognition
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                  description: ''
                  example: modi
                text:
                  type: string
                  description: ''
                  example: cupiditate
                entities:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                data_bucket_id:
                  type: string
                  description: ''
                  example: dignissimos
              required:
                - lang
                - text
      security: []
  /api/models/products:
    post:
      summary: ''
      operationId: postApiModelsProducts
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'Le texte value doit contenir au moins 5 caractères. Le texte de value ne peut contenir plus de 4000 caractères.'
                  example: mcyqd
                data_bucket_id:
                  type: string
                  description: ''
                  example: dolorem
              required:
                - text
      security: []
  /api/models/satisfaction:
    post:
      summary: ''
      operationId: postApiModelsSatisfaction
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: ''
                  example: doloremque
                data_bucket_id:
                  type: string
                  description: ''
                  example: quam
              required:
                - text
      security: []
  /api/models/stars_estimation:
    post:
      summary: ''
      operationId: postApiModelsStars_estimation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'Le texte value doit contenir au moins 5 caractères. Le texte de value ne peut contenir plus de 4000 caractères.'
                  example: lnaw
                data_bucket_id:
                  type: string
                  description: ''
                  example: in
              required:
                - text
      security: []
  /api/models/touchpoints:
    post:
      summary: ''
      operationId: postApiModelsTouchpoints
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'Le texte de value ne peut contenir plus de 4000 caractères.'
                  example: qqqawszzbfpds
                data_bucket_id:
                  type: string
                  description: ''
                  example: minima
              required:
                - text
      security: []
  /api/models/translation:
    post:
      summary: ''
      operationId: postApiModelsTranslation
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: 'Le texte de value ne peut contenir plus de 4000 caractères.'
                  example: zbptgkdrsrurqwi
                input_locale:
                  type: string
                  description: ''
                  example: en_CA
                output_locale:
                  type: string
                  description: ''
                  example: sr_CS
                data_bucket_id:
                  type: string
                  description: ''
                  example: suscipit
              required:
                - text
                - output_locale
      security: []
  /api/models/multiple:
    post:
      summary: ''
      operationId: postApiModelsMultiple
      description: ''
      parameters: []
      responses: {  }
      tags:
        - 'Models Endpoints'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: ''
                  example: voluptate
                models:
                  type: array
                  description: ''
                  example:
                    - ipsa
                  items:
                    type: object
                    properties:
                      '*':
                        type: object
                        description: ''
                        example:
                          parameters: null
                        properties:
                          parameters:
                            type: object
                            description: ''
                            example: null
                            properties: {  }
                parameters:
                  type: object
                  description: ''
                  example: null
                  properties: {  }
                data_bucket_id:
                  type: string
                  description: ''
                  example: ea
              required:
                - text
                - models
      security: []
  '/api/models/{internalModel_slug}':
    get:
      summary: ''
      operationId: getApiModelsInternalModel_slug
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    slug: actions-extraction
                    key: actions-extraction
                    title: 'Extraction of call actions'
                    description: 'Transcribe and analyze your customers calls (multilingual transcription and analysis) to identify the actions that either took place during the call or are recommended to be completed after the call, with no data required and no additional training'
                    requires_parameters: false
                    requires_context: true
                    requires_locales: false
                    requires_multiple_rows: false
                    multiple_rows_columns: null
                    requires_tags: null
                    requires_presets: null
                    available_locales: null
                    parameters: null
                    content: "## Description\n\nTranscribe and analyze your customers calls (multilingual transcription and analysis) to identify the actions that either took place during the call or are recommended to be completed after the call, with no data required and no additional training.\nThis model developed by <span>Diabolocom.ai</span> is trained to identify and extract the actions listed during your customer calls, including reason clarification and responsability assignment as well as completion state guidance, based on a call (audio) transcription, without further information.<br/>\nIt assists in tracking responsibilities and follow-up tasks.\n\nThis analysis includes the following features :\n- Action Items Extraction : Identifiying and listing specific actions that were discussed during the call\n- Reason Clarification : Providing clarity on the 'why' - the reasons behind each action item\n- Responsibility Assignment : Specifiying which party (agent or client) is responsible for each action item, aiding in accountability\n- Completion state Guidance : Providing guidance for each action to determine if it's completed during the call or should be performed after the call\n\nWhen you run the model, you will have these generated results :\n- The timestampted call transcript : The transcribed call (audio) including separate timestampted conversation lines for each speaker (Client/Agent)\n- The list of identified actions, having each the following details :\n\t- The action title : The action name in the format of a short description with key elements\n\t- The action reason : The underlying reason or purpose behind the action\n\t- The action responsible : The party responsible of the action (agent or client)\n\t- The action completion state : The action status depending on whether it is identified as completed during the call or should be performed after the call\n\t- The action steps : The list of sub-tasks/steps that define the action\n\n![Example](__APP_URL__storage/img/actions-extraction_en.svg \"Example\")\n\n## How to use\n- Upload a stereo phone call : Dual-channel audio (mp3, wav) < 60mb. For a better transcription and analysis quality, make sure that the channel dedicated for the Agent is the stereo right channel, and the channel dedicated for the Client is the stereo left channel\n- Choose your input audio language\n- Choose your AI analysis results language : Specify the analysis output language you want (can be different from your input audio language to enable cross-lingual analysis of the call)\n- Provide your company name : Introduce our model to the name of your company\n- Write a brief context of the call : Introduce our model to the context of the input audio\n\nExplore our model API to take advantage of additional features : \n- Transcription and analysis of defined segments of the call (ability to crop the audio)\n- Reception of a webhook message on successful AI analysis\n\n## Possible uses\n- In-depth analysis of specific calls : VIP customer calls, specific queue calls, calls with empty or no explicit post-call qualification/commentary or follow-up action list, ...\n- Agent performance assessment during the call and Quality Monitoring\n- Pre-filling of post-call follow-up fields to improve agents efficiency and reduce post-call time : call qualification, call summary/commentary, task/action list, ...\n- Integration of AI analysis generated results (actions list with parameters title, reason, responsible, completion state, steps) with CCaaS or CRM/ticketing tool : create a task/action list to perform, update the customer record, interaction or case record, ...\n- Execution of various automated processes depending on the call actions completed or to perform\n- Any other use : we provide the information, you do what you want with it !"
                    available_languages: []
                    require_file_field: true
                    without_text_area: true
                    limitations: 'This Diabolocom.ai analysis allows you to identify and extract the actions listed during your customer calls, including reason clarification and responsability assignment as well as completion state guidance, based on a call (audio) transcription, without any prior data. If the call content (audio) is not explicit enough because of speakers overlap or another possible reason, the resulting transcript may not exactly match the call content and the generated results may not be correct.'
                    icon: SPEAKER
                    secondary_icon: null
                    color: 9F70FD
                    documentation_url: 'https://developer.diabolocom.com/#12762abb-6874-4a35-9cc1-c7d3fe211a28'
                    documentation_url_2: null
                    category: voice
                    text_input_key: null
                properties:
                  data:
                    type: object
                    properties:
                      slug:
                        type: string
                        example: actions-extraction
                      key:
                        type: string
                        example: actions-extraction
                      title:
                        type: string
                        example: 'Extraction of call actions'
                      description:
                        type: string
                        example: 'Transcribe and analyze your customers calls (multilingual transcription and analysis) to identify the actions that either took place during the call or are recommended to be completed after the call, with no data required and no additional training'
                      requires_parameters:
                        type: boolean
                        example: false
                      requires_context:
                        type: boolean
                        example: true
                      requires_locales:
                        type: boolean
                        example: false
                      requires_multiple_rows:
                        type: boolean
                        example: false
                      multiple_rows_columns:
                        type: string
                        example: null
                      requires_tags:
                        type: string
                        example: null
                      requires_presets:
                        type: string
                        example: null
                      available_locales:
                        type: string
                        example: null
                      parameters:
                        type: string
                        example: null
                      content:
                        type: string
                        example: "## Description\n\nTranscribe and analyze your customers calls (multilingual transcription and analysis) to identify the actions that either took place during the call or are recommended to be completed after the call, with no data required and no additional training.\nThis model developed by <span>Diabolocom.ai</span> is trained to identify and extract the actions listed during your customer calls, including reason clarification and responsability assignment as well as completion state guidance, based on a call (audio) transcription, without further information.<br/>\nIt assists in tracking responsibilities and follow-up tasks.\n\nThis analysis includes the following features :\n- Action Items Extraction : Identifiying and listing specific actions that were discussed during the call\n- Reason Clarification : Providing clarity on the 'why' - the reasons behind each action item\n- Responsibility Assignment : Specifiying which party (agent or client) is responsible for each action item, aiding in accountability\n- Completion state Guidance : Providing guidance for each action to determine if it's completed during the call or should be performed after the call\n\nWhen you run the model, you will have these generated results :\n- The timestampted call transcript : The transcribed call (audio) including separate timestampted conversation lines for each speaker (Client/Agent)\n- The list of identified actions, having each the following details :\n\t- The action title : The action name in the format of a short description with key elements\n\t- The action reason : The underlying reason or purpose behind the action\n\t- The action responsible : The party responsible of the action (agent or client)\n\t- The action completion state : The action status depending on whether it is identified as completed during the call or should be performed after the call\n\t- The action steps : The list of sub-tasks/steps that define the action\n\n![Example](__APP_URL__storage/img/actions-extraction_en.svg \"Example\")\n\n## How to use\n- Upload a stereo phone call : Dual-channel audio (mp3, wav) < 60mb. For a better transcription and analysis quality, make sure that the channel dedicated for the Agent is the stereo right channel, and the channel dedicated for the Client is the stereo left channel\n- Choose your input audio language\n- Choose your AI analysis results language : Specify the analysis output language you want (can be different from your input audio language to enable cross-lingual analysis of the call)\n- Provide your company name : Introduce our model to the name of your company\n- Write a brief context of the call : Introduce our model to the context of the input audio\n\nExplore our model API to take advantage of additional features : \n- Transcription and analysis of defined segments of the call (ability to crop the audio)\n- Reception of a webhook message on successful AI analysis\n\n## Possible uses\n- In-depth analysis of specific calls : VIP customer calls, specific queue calls, calls with empty or no explicit post-call qualification/commentary or follow-up action list, ...\n- Agent performance assessment during the call and Quality Monitoring\n- Pre-filling of post-call follow-up fields to improve agents efficiency and reduce post-call time : call qualification, call summary/commentary, task/action list, ...\n- Integration of AI analysis generated results (actions list with parameters title, reason, responsible, completion state, steps) with CCaaS or CRM/ticketing tool : create a task/action list to perform, update the customer record, interaction or case record, ...\n- Execution of various automated processes depending on the call actions completed or to perform\n- Any other use : we provide the information, you do what you want with it !"
                      available_languages:
                        type: array
                        example: []
                      require_file_field:
                        type: boolean
                        example: true
                      without_text_area:
                        type: boolean
                        example: true
                      limitations:
                        type: string
                        example: 'This Diabolocom.ai analysis allows you to identify and extract the actions listed during your customer calls, including reason clarification and responsability assignment as well as completion state guidance, based on a call (audio) transcription, without any prior data. If the call content (audio) is not explicit enough because of speakers overlap or another possible reason, the resulting transcript may not exactly match the call content and the generated results may not be correct.'
                      icon:
                        type: string
                        example: SPEAKER
                      secondary_icon:
                        type: string
                        example: null
                      color:
                        type: string
                        example: 9F70FD
                      documentation_url:
                        type: string
                        example: 'https://developer.diabolocom.com/#12762abb-6874-4a35-9cc1-c7d3fe211a28'
                      documentation_url_2:
                        type: string
                        example: null
                      category:
                        type: string
                        example: voice
                      text_input_key:
                        type: string
                        example: null
      tags:
        - 'Models Endpoints'
      security: []
    parameters:
      -
        in: path
        name: internalModel_slug
        description: 'The slug of the internalModel.'
        example: actions-extraction
        required: true
        schema:
          type: string
tags:
  -
    name: 'Account/User Management Endpoints'
    description: 'List of endpoints to manage user and account access/security'
  -
    name: 'Databuckets Endpoints'
    description: 'List of endpoints associated to databuckets'
  -
    name: 'Inference Endpoints'
    description: 'List of endpoints for inference'
  -
    name: 'Models Endpoints'
    description: 'List of endpoints for specific models and models infos'
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.'
security:
  -
    default: []
