Web Service Method: Request Extracted Terms of a Corpus

Abstract

Description
Returns extracted terms generated during corpus analysis.

URL: /PoolParty/api/corpusmanagement/{project}/results/extractedterms

Request

Supported Methods
GET

Path Variables

Variable	Comment
`{project}`	The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters

Parameter	Comment	Type	Required
corpusId	The corpus that contains the requested documents. Note Please note that the provided value should start with "corpus:". The ID alone is not sufficient. An example for corpusId value could be `corpus:a7b55be0-17c6-44b6-807c-064c6734f03e`	String	true
startIndex	The result set is limited to 20 concepts. The user can define the startIndex of the result set to retrieve concepts with higher index number. The default startIndex is 0.	Integer	false
limit	Limit of returned extracted terms (default:20)	Integer	false

Parameter

Comment

Type

Required

corpusId

The corpus that contains the requested documents.

Note

Please note that the provided value should start with "corpus:". The ID alone is not sufficient.

An example for corpusId value could be corpus:a7b55be0-17c6-44b6-807c-064c6734f03e

String

true

startIndex

The result set is limited to 20 concepts. The user can define the startIndex of the result set to retrieve concepts with higher index number.

The default startIndex is 0.

Integer

false

limit

Limit of returned extracted terms (default:20)

Integer

false

Response

Returns

Array of corpora (JSON) in requested PoolParty project.

Attribute	Type	Comment
name	String	Extracted term
contentTermScore	String	Content Term score
mutualInformationScore	String	Mutual Information score
combinedRelevanceScore	String	Relevance score
frequencyInCorpus	Integer	Frequency of the extracted term in corpus

Example

Example Request

http://<server-url>/PoolParty/api/corpusmanagement/1DCE489D-9695-0001-E272-285217B0181E/results/extractedterms?corpusId=corpus:e62d3b7e-ce07-48c0-b2c3-696a159227e2

Example Response

[
    {
        "uri": {
            "uri": "extractedTermView:ebb02b1f-ba52-4741-adfc-a24c3fcdb20f"
        },
        "name": "updates set",
        "contentTermScore": -0.177,
        "mutualInformationScore": -3.73,
        "frequencyInCorpus": 1,
        "combinedRelevanceScore": 0.32,
        "candidate": null,
        "blacklisted": null
    },
    {
        "uri": {
            "uri": "extractedTermView:f8825a3d-cf68-4a87-bb7b-4fe380f6476a"
        },
        "name": "properties macro",
        "contentTermScore": -0.177,
        "mutualInformationScore": -5.53,
        "frequencyInCorpus": 1,
        "combinedRelevanceScore": 0.32,
        "candidate": null,
        "blacklisted": null
    }, ...
]

In this section: