Skip to main content

List all documents from an analysis​

List all documents from an analysis. The list of documents can be filtered by providing query parameters such as 'search' , 'classes', 'labels', 'details' or paginated with 'offset' and 'limit'.

Path Parameters
  • analysis_id integer required

    ID of the analysis to get

Query Parameters
  • details string

    Possible values: [segments, meta, tags]

    Which details should return. Values might be any combination of 'segments', 'meta' and 'tags'.

    • segments: Show segments of a document
    • meta: Show all the additional attributes that were originally given as the document was uploaded
    • tags: Show tags of a document
  • search string

    Search by name

  • classes integer[]

    filter by class ids

    Example: 1,746
  • labels integer[]

    filter by label ids

    Example: 110,111,112
  • offset integer

    An offset is simply the number of records you wish to skip before selecting records.

  • limit integer

    Possible values: >= 1 and <= 1000

    Default value: 100

    Limit of entries that should be returned.

Responses

OK

Schema
  • documents object

    A document with the segments and tags

  • text string

    The document text

  • segments object[]

    list of segments

  • text string

    The segment text

  • span integer[]

    The interval at which the segment occurs in the original document

  • tags object[]

    A list of tags

  • class string

    The class's name.

  • label string

    The label's name.

  • has_more boolean

    indicates if a new request with a different offset should be done to get more models.

  • offset integer

    An offset is simply the number of records you wish to skip before selecting records.

  • limit integer

    Limit of entries that should be returned.

  • count integer

    Number of objects returned

Loading...