Web Service Method: Create a TF-IDF Corpus
Web Service Method: Create a TF-IDF Corpus
Description |
|---|
Creates a TF-IDF corpus. |
URL: /PoolParty/api/corpusmanagement/{projectiID}/createTfidfIndex
application/x-www-form-urlencoded
Supported Methods |
|---|
GET |
POST |
Parameter | Type | Required | Description |
|---|---|---|---|
corpusId | Array of String | true | A list of corpus IDs from which the TFIDF corpus will be created. NoteThe system will check if the provided corpus IDs are listed in the respective project. |
language | String | true | The corpus language |
Example Request
http://<server>/PoolParty/api/corpusmanagement/createTfidfIndex?projectId=1DBC7CF4-27E4-0001-C48E-155A7E941ABE&corpusId=c4bf3d2a-cb2e-4f30-920b-d511d7fd51c8&language=de
application/json
A basic response object containing a message and indicating the success of the operation in the success field.
Attribute | Type | Required | Comment |
|---|---|---|---|
message | String | false | short descriptive message of the operation result, or an error description |
result | Object | false | the actual response content body, defined by the resultType. |
resultType | String | false | MIME type of the result if successful, or Exception type if an error occurred |
status | int | true | indicates the success or error of the HTTP request, on the protocol layer |
success | boolean | false | true if the operation was successful, on the application layer |
Note
The return to this request will display these errors in the following specific cases:
If the Search Space ID is wrong, you will receive a 404 'Bad Request' message, with specific information in a JSON message as to the value that was not found.
If the credentials were mistyped or wrong: a 403 Forbidden, and a JSON message 'Access denied' will be returned.
If you didn't specify a Search Space ID: the return will be made for the default Search Space.
If the default Search Space is private and you are not authenticated, you will also receive a 403 Forbidden in a JSON message.
{
"result" : { },
"success" : true,
"message" : "some message",
"resultType" : "some resultType",
"status" : 13829
}