The WordWorks API is currently deployed on Vercel and provides several API endpoints for word retrieval, info, natural language processing, and more.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"36348829","collectionId":"e192d063-7921-4e7e-9916-fa5d35d71d9b","publishedId":"2sA3kSoNjY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-18T19:27:34.000Z"},"item":[{"name":"NLP","item":[{"name":"Emotion Classification","event":[{"listen":"test","script":{"id":"94af3a2f-a77c-4de6-8e7f-e72c3649ca62","exec":["pm.test('Response status code is 200', function () {"," pm.response.to.have.status(200);","})","","pm.test('Response should have content type of application/json', function () {"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');","})","","pm.test('Emotions array is present in the response', function () {"," const responseData = pm.response.json();"," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.emotions).to.exist.and.to.be.an('array');","})","var template = `","","","| Label | ","Score | ","
|---|---|
| {{label}} | ","{{score}} | ","
This endpoint retrieves the emotions associated with the provided text. The request should include a query parameter \"text\" with the value being the input text for which emotions are to be analyzed.
\nIt makes use of the Huggingface Inference API to access the model at the space here:
\nhttps://huggingface.co/spaces/Best-codes/SamLowe-roberta-base-go_emotions
\nHTTP GET Requests are supported
\nHTTP POST Requests are supported
\ntext (string): The input text for which emotions are to be analyzed.Upon successful execution, the server responds with a status code of 200 and a JSON object in the following format:
\n{\n \"emotions\": [\n {\n \"label\": \"\",\n \"score\": 0\n }\n ]\n}\n\nThe emotions array contains objects with \"label\" and \"score\" properties representing the emotions and their corresponding scores for the provided text.
Text to classify
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[]}},"response":[],"_postman_id":"2213bb59-14c5-4e78-be58-74c349cedfcd"},{"name":"Parts of Speech Tagging","event":[{"listen":"test","script":{"id":"40478b5a-d23c-4bec-ad7a-3caa650068de","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData).to.have.property('status');"," pm.expect(responseData).to.have.property('message');"," pm.expect(responseData).to.have.property('partsOfSpeech');","});","","","pm.test(\"Each element in partsOfSpeech array has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.partsOfSpeech).to.be.an('array').that.is.not.empty;"," "," responseData.partsOfSpeech.forEach(function(part) {"," pm.expect(part).to.have.property('value').that.is.a('string');"," pm.expect(part).to.have.property('tag').that.is.a('string');"," pm.expect(part).to.have.property('normal').that.is.a('string');"," pm.expect(part).to.have.property('pos').that.is.a('string');"," pm.expect(part).to.have.property('lemma').that.is.a('string');"," });","});","","","pm.test(\"Value and Normal fields should be non-empty strings\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.partsOfSpeech).to.be.an('array');"," "," responseData.partsOfSpeech.forEach(function(part) {"," pm.expect(part.value).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Value should not be empty\");"," pm.expect(part.normal).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Normal should not be empty\");"," });","});","","","pm.test(\"Parts of Speech tags are either 'word' or 'punctuation'\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.partsOfSpeech).to.be.an('array');"," "," responseData.partsOfSpeech.forEach(function(part) {"," pm.expect(part.tag).to.satisfy(function(tag) {"," return tag === 'word' || tag === 'punctuation';"," }, \"Tag should be either 'word' or 'punctuation'\");"," });","});","var template = `","","","| Value | ","Tag | ","Normal | ","POS | ","Lemma | ","
|---|---|---|---|---|
| {{value}} | ","{{tag}} | ","{{normal}} | ","{{pos}} | ","{{lemma}} | ","
This endpoint retrieves the parts of speech for the provided text.
\ntext (string): The input text for which parts of speech are to be analyzed.Upon successful execution, the server responds with a status code of 200 and a JSON object in the following format:
\n{\n \"status\": \"success\",\n \"message\": \"Parts of Speech fetched successfully\",\n \"partsOfSpeech\": [\n {\n \"value\": \"\",\n \"tag\": \"\",\n \"normal\": \"\",\n \"pos\": \"\",\n \"lemma\": \"\"\n }\n ]\n}\n\nThe partsOfSpeech array contains objects with \"value\", \"tag\", \"normal\", \"pos\", and \"lemma\" properties representing the texts in the sentence and their POS data, as shown below:
value: the classified text chunk in the object (e.g.: string)tag: the tag of the classified text chunk in the object (e.g.: word | punctuation)normal: the normal format of the classified text chunk (e.g.: String = string)pos: the part of speech of the classified text chunk (e.g.: NN)lemma: the technical form of the classified text chunk. A lemma is a form of a word that appears as an entry in a dictionary and is used to represent all the other possible forms. (e.g.: strings = string)Text to classify
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[]}},"response":[],"_postman_id":"ea943a2f-e77f-41dd-9c24-8c941e20de62"},{"name":"Sentiment Analysis","event":[{"listen":"test","script":{"id":"dc8e352c-bb40-44a2-89e6-5d07a25a5c4c","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response has the required fields - status and sentimentScore\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.status).to.exist;"," pm.expect(responseData.sentimentScore).to.exist;","});","","","pm.test(\"Sentiment score is within the valid range (-3 to 3)\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.sentimentScore).to.be.within(-3, 3);","});","","","pm.test(\"Status field is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.status).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Status should not be empty\");","});","","","pm.test(\"Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","var template = `","","","| Status | ","Sentiment Score | ","
|---|---|
| {{response.status}} | ","{{response.sentimentScore}} | ","
This endpoint retrieves the sentiment score for a given text.
\ntext (string): The input text for which sentiment is to be analyzed.The response for this request is a JSON object with the following format:
\n{\n \"status\": \"\",\n \"sentimentScore\": 0\n}\n\nThe sentimentScore can be between -3 and 3. Negative numbers represent negative sentiment (e.g., hate is -3), while positive numbers represent positive sentiment (e.g., love is 2). 0 is equivalent to neutral.
The classifier works best with short phrases or single words and may throw errors when checking long texts.
\n","urlObject":{"protocol":"https","path":["api","nlp","sentiment"],"host":["wordworks-api","vercel","app"],"query":[{"description":{"content":"Text to classify
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[]}},"response":[],"_postman_id":"e1837c38-9a98-4e09-bacf-2af268e2a207"},{"name":"Tokenizer","event":[{"listen":"test","script":{"id":"e5b1166a-7329-40f3-bdab-ec914334cdee","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","","","pm.test(\"Response has the required fields - status, message, and tokens\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.status).to.exist;"," pm.expect(responseData.message).to.exist;"," pm.expect(responseData.tokens).to.exist;","});","","","pm.test(\"Tokens array is not empty\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.tokens).to.be.an('array').and.to.have.lengthOf.at.least(1, \"Tokens array should not be empty\");","});","","","pm.test(\"Each token in the response is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.tokens).to.be.an('array');"," responseData.tokens.forEach(function(token) {"," pm.expect(token).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Token should not be empty\");"," });","});","var template = `","","","| Tokens | ","
|---|
| {{this}} | ","
The endpoint tokenizes the provided input text.
\nhttps://www.machinelearningplus.com/nlp/what-is-tokenization-in-natural-language-processing/
\ntext (string): The input text to be tokenized.The response for this request is a JSON object with the following format:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"tokens\": [\n \"\"\n ]\n}\n\nText to tokenize
\n","type":"text/plain"},"key":"text","value":"string"}],"variable":[]}},"response":[],"_postman_id":"5084f096-8415-4c97-80cb-f921b81d1603"}],"id":"a34c4b76-04ee-4a27-9971-477c34b4d067","description":"Natural Language Processing API endpoints.
\n","_postman_id":"a34c4b76-04ee-4a27-9971-477c34b4d067"},{"name":"Sentence","item":[{"name":"Random Sentence (Phrase)","event":[{"listen":"test","script":{"id":"eb6c0c89-b414-4e99-a2cb-2a8b743f9846","exec":["pm.test(\"Response status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","pm.test(\"Response Content-Type is application/json\", function () {"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");","});","","","pm.test(\"Data field should not be empty\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.exist.and.to.not.be.empty;","});","","","pm.test(\"Data field is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.data).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Data field should not be empty\");","});","","","pm.test(\"Response contains the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.have.property('data');","});","var template = `","","","| Data | ","
|---|
| {{response.data}} | ","
This endpoint creates a random sentence based on the provided words and separator. The request parameters include an array of words and a separator to be used in the sentence.
\nwords (string): The parts of speech, in the intended order, used to create the sentence.separator (string): The separator character to seperate each word in the sentence.The response for this request is a JSON object with the following format:
\n{\n \"data\": \"\"\n}\n\nNeither request parameter is required. The default words array is [\"verb\", \"adj\", \"noun\"], and the default separator is -.
Supported parts of speech for the words array are:
verb: Verb. Currently, the API randomly chooses whether the verb is past or present tense.adj: Adjective.noun: Noun.adverb: Adverb.Array of parts of speech to use in the sentence. Not required.
\n","type":"text/plain"},"key":"words","value":"[\"verb\", \"adj\", \"noun\"]"},{"description":{"content":"Seperator between words. Not required.
\n","type":"text/plain"},"key":"separator","value":"_"}],"variable":[]}},"response":[],"_postman_id":"a0d03231-46c3-4a16-9658-6263e4fd5d69"}],"id":"e864ce0f-2f9a-44a8-816f-40d38fe83ca8","description":"API endpoints for sentence manipulation and generation.
\n","_postman_id":"e864ce0f-2f9a-44a8-816f-40d38fe83ca8"},{"name":"Words","item":[{"name":"List of Words","event":[{"listen":"test","script":{"id":"ef804f02-b33f-41a0-80df-55cdd357f8bd","exec":["pm.test('Response status code is 200', function () {"," pm.response.to.have.status(200);","})","","pm.test('Response has the required fields', function () {"," const responseData = pm.response.json();"," pm.expect(responseData).to.have.property('status');"," pm.expect(responseData).to.have.property('message');"," pm.expect(responseData).to.have.property('wordArrayLength');"," pm.expect(responseData).to.have.property('words');","})","","pm.test('WordArrayLength is a non-negative integer', function () {"," const responseData = pm.response.json();"," pm.expect(responseData.wordArrayLength).to.be.a('number');"," pm.expect(responseData.wordArrayLength).to.be.at.least(0);","})","","pm.test('Content-Type header is application/json', function () {"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');","})","var template = `","","","| Words | ","
|---|
| {{this}} | ","
This endpoint retrieves a list of words.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format with the following schema:
\nstatus (string): The status of the response.message (string): A message related to the response.wordArrayLength (integer): The length of the array of words.words (array of strings): An array containing the words.Example response:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"wordArrayLength\": 0,\n \"words\": [\"\"]\n}\n\n| Status | ","Message | ","Word | ","
|---|---|---|
| {{response.status}} | ","{{response.message}} | ","{{response.word}} | ","
This endpoint retrieves a random word from the WordWorks API.
\nNo request body is required for this endpoint.
\nThe response will be in JSON format with the following schema:
\nstatus (string): The status of the response.message (string): Any additional message related to the response.word (string): The random word retrieved from the API.Example:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"word\": \"\"\n}\n\n| Words | ","
|---|
| {{this}} | ","
This endpoint searches for words based on various criteria such as start, end, contains, and length. The request parameters are:
\nstartsWith (string): Specifies the starting letter of the word to be searched.endsWith (string): Specifies the ending letter of the word to be searched.contains (string): Specifies a specific sequence of letters that the word must contain.length (integer): Specifies the length of the word to be searched.limit (integer): Specifies the maximum number of words to be returned in the response.The response to the request is in JSON format with the following structure:
\nstatus (string): Indicates the status of the response.message (string): Provides additional information about the response.wordArrayLength (integer): Represents the length of the array of words returned.words (array of strings): Contains the list of words that meet the search criteria.Example response:
\n{\n \"status\": \"\",\n \"message\": \"\",\n \"wordArrayLength\": 0,\n \"words\": [\"\"]\n}\n\nThe string the word must start with. Not required. Case sensitive.
\n","type":"text/plain"},"key":"startsWith","value":"A"},{"description":{"content":"The string the word must end with. Not required. Case sensitive.
\n","type":"text/plain"},"key":"endsWith","value":"B"},{"description":{"content":"The string the word must contain. Not required. Case sensitive.
\n","type":"text/plain"},"key":"contains","value":"SOR"},{"description":{"content":"The length of the word. Not required.
\n","type":"text/plain"},"key":"length","value":"6"},{"description":{"content":"The limit to the number of search results. Not required.
\n","type":"text/plain"},"key":"limit","value":"10"}],"variable":[]}},"response":[],"_postman_id":"1d9148eb-6322-4789-98ff-62f9f8fea8f2"}],"id":"ef64e209-20f0-4b21-a3ad-d95164466ac5","description":"API requests for word fetching and manipulation.
\n","_postman_id":"ef64e209-20f0-4b21-a3ad-d95164466ac5"}]}