Create requirements analyser

Analyzes free-text requirements/specification content and extracts structured requirements-engineering artifacts (actors, use cases, constraints, business rules, and more) for each requested category, using NLP sentence-similarity matching.

POST /++requirements_analyser

Requirements Analyser

Authentication

Requires an authenticated (logged-in) account.

Request

Content type: application/json

Name	In	Type	Required	Description
`text`	body	string	No	—
`probes`	body	string	No	—
`outputs`	body	string	No	—
`threshold`	body	string	No	—
`keywords`	body	string	No	—
`BODY`	body	string	No	—
`actors`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`assumptions`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`business_rules`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`columns`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`compliance_legal`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`constraints`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`dependencies`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`description`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`exceptions`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`goals`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`non_functional_requirements`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`requirements`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`risks`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`rows`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`scenarios`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`stakeholders`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`states`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`use_cases`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`user_stories`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`vision`	body	string	No	Sent by the web client (found via frontend call-site tracing).
`roles`	query	string	No	Sent by the web client (found via frontend call-site tracing).

Example request body

{
  "text": "example_value",
  "probes": "example_value",
  "outputs": "example_value",
  "threshold": "example_value",
  "keywords": "example_value",
  "BODY": "example_value",
  "actors": "example_value",
  "assumptions": "example_value"
}

Responses

Status	Meaning
`200`	Successful response.
`500`	Internal server error.
`401`	Unauthorized - authentication required.
`403`	Forbidden - the current user or Integrator registration does not have sufficient permissions.

Requirements Analyser