KNOWLEDGE BOX

Each knowledge box has a unique URL which format is::

https://flaps.io/api/ZONE/ACCOUNT/KB

BM25 search endpoint is called::

GET https://flaps.io/api/ZONE/ACCOUNT/KB/@search

Possible query parameters:

  • q: query to search text based on it. Supports specific search syntax:
    • title:VALUE: search on title
    • body:VALUE: search on body
    • summary:VALUE: search on summary
    • sentences: >VALUE or sentences: <VALUE: filter by amount of sentences
    • modified: >VALUE: filter by modified
    • created: >VALUE: filter by created
    • VALUE AND VALUE: all values must be there
    • VALUE OR VALUE: needs to much at least on value
    • NOT VALUE: a value should not be there
    • ": exact phrase match
  • tags: tags to filter. Tags are formated in base64 with the format of l/LABELSET/LABEL or n/TYPE or i/LANGUAGE or e/ENTITY
  • users: users to filter. Users are formated in multiple parameters list in base64 format
  • origins: origins to filter. Origins are formated in multiple parameters list in base64 format
  • icons: icons to filter. Icons are formated in multiple parameters list in base64 format
  • from: from which resource to show
  • size: number of elements to return
  • des: from which date
  • fins: to which date

Results JSON value:

  • total: Int: total of numbers
  • facets: Object:
    • icon: Object:
      • facetresults: Array elements:
        • tag: String of icon value
        • total: Total amount available
    • origin:
      • facetresults: Array elements:
        • tag: String of origin value
        • total: Total amount available
    • tags:
      • facetresults: Array elements:
        • tag: String of tag value
        • total: Total amount available
    • users:
      • facetresults: Array elements:
        • tag: String of user value
        • total: Total amount available
  • results: Array elements:
    • created: Date ISO String
    • icon: String type
    • id: String path ID
    • modified: Date ISO String
    • origin: Origin type
    • score: Float
    • summary: HTML summary String
    • tags: List of tags
    • thumbnail: Thumbnail path based on resource path
    • title: String
    • users: Involved users on resource
    • uuid: Internal uuid String

Semantic search endpoint is called::

GET https://flaps.io/api/ZONE/ACCOUNT/KB/@flaps

Possible query parameters:

  • q: query to search text based on it.
  • size: number of resources to return
  • ask: if its defined will try to answer the question

Results JSON value:

  • possible_results_text: Similar sentences on any document
    • text: HTML String of the text to show
    • uuid: Internal uuid String
    • distance: Float distance with query
    • created: Date ISO String
    • modified: Date ISO String
    • title: String
    • solution: Linked solution if exist on resource
    • labels: Classifications on the resource
    • thumbnail: Thumbnail path based on resource path
    • icon: Type of resource
    • id: String path ID
  • similar_questions: If ask is defined will return other questions of conversational resources
    • text: HTML String of the text to show
    • uuid: Internal uuid String
    • distance: Float distance with query
    • title: String
    • solution: Linked solution if exist on resource
    • thumbnail: Thumbnail path based on resource path
    • labels: Classifications on the resource
    • icon: Type of resource
    • id: String path ID
  • possible_answer: If ask is defined will define a vector of the possible solution if there is a trained model

BM25 search endpoint is called::

GET https://flaps.io/api/ZONE/ACCOUNT/KB/@paragraph

Possible query parameters:

  • q: query to search text based on it. Supports specific search syntax:
  • tags: tags to filter. Tags are formated in base64 with the format of l/LABELSET/LABEL or n/TYPE or i/LANGUAGE or e/ENTITY
  • users: users to filter. Users are formated in multiple parameters list in base64 format
  • origins: origins to filter. Origins are formated in multiple parameters list in base64 format
  • icons: icons to filter. Icons are formated in multiple parameters list in base64 format
  • from: from which resource to show
  • size: number of elements to return
  • des: from which date
  • fins: to which date
  • fast: if its defined will perform a fast query

Results JSON value:

  • total: total number of paragraphs
  • page_number: page number of results
  • result_per_page: number of results on a page
  • exhaustive: if its fast its not exhaustive
  • time: time to execute
  • status: its ok or not
  • results: List of paragraphs
    • title: String title of document
    • uuid: Internal String ID
    • icon: Type of document
    • origin: Origin of document
    • modified: Modified date as ISO String
    • created: Created date as ISO String
    • tags: Tags on the document
    • users: Users on the document
    • id: ID path of the document
    • body: Paragraph
    • thumbnail: Path of the thumbnail of the document
    • order: Order of the paragraph in the document
  • facets: Object:
    • icon: Object:
      • facetresults: Array elements:
        • tag: String of icon value
    • origin:
      • facetresults: Array elements:
        • tag: String of origin value
    • tags:
      • facetresults: Array elements:
        • tag: String of tag value
    • users:
      • facetresults: Array elements:
        • tag: String of user value

ANSWER

TODO

AUDIT LOG

TODO

LIST AND FILTER

TODO

NAMED AND CUSTOM ENTITIES

To get all found named entities::

GET https://flaps.io/api/ZONE/ACCOUNT/KB/@namedEntities

ONTHOLOGY

TODO

RECENT ACTIVITY

TODO

TEMPLATES

TODO

STATS

TODO

NOTIFICATIONS AND WEBSOCKET

TODO

results matching ""

    No results matching ""