GET api/artificialintelligence/generatedescription?roleId={roleId}&intendedMarket={intendedMarket}&descriptionType={descriptionType}
Generate a text description using AI based on the stored data for the provided role Id. This endpoint is intended for roles that have UMP enabled. Processes this brainz description API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| roleId |
The unique identifier of the role resource. |
integer |
Required |
| intendedMarket |
The intended market value supplied with the request. |
string |
Required |
| descriptionType |
The description type value supplied with the request. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version |
The version value. |
Version |
None. |
| Content |
The content value. |
HttpContent |
None. |
| StatusCode |
The status code classification. |
HttpStatusCode |
None. |
| ReasonPhrase |
The reason phrase value. |
string |
None. |
| Headers |
The collection of headers. |
Collection of Object |
None. |
| RequestMessage |
The request message value. |
HttpRequestMessage |
None. |
| IsSuccessStatusCode |
Indicates whether this item is success status code. |
boolean |
None. |