This is an automated email from the ASF dual-hosted git repository.
aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git
The following commit(s) were added to refs/heads/master by this push:
new 9dfa23a Update nlpcraft_swagger.yml
9dfa23a is described below
commit 9dfa23a3c3d64907c49424a2299d9e2b606bc8a9
Author: Aaron Radzinski <[email protected]>
AuthorDate: Mon Nov 30 10:28:22 2020 -0800
Update nlpcraft_swagger.yml
---
openapi/nlpcraft_swagger.yml | 365 ++++++++++++++++++++++---------------------
1 file changed, 184 insertions(+), 181 deletions(-)
diff --git a/openapi/nlpcraft_swagger.yml b/openapi/nlpcraft_swagger.yml
index d11ce0a..be56ea3 100644
--- a/openapi/nlpcraft_swagger.yml
+++ b/openapi/nlpcraft_swagger.yml
@@ -75,24 +75,24 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
mdlId:
type: string
maxLength: 32
- description: Data model ID for which to clear conversation
+ description: Data model ID for which to clear conversation.
usrId:
type: integer
format: int64
description: >-
- User ID for which to clear conversation. Optional, caller
user ID used by default.
+ Optional. User ID for which to clear conversation. Optional,
caller user ID used by default.
Clearing conversation for other users from the same company
requires administrative
privileges. If both user ID and external 'on-behalf-of' user
ID are provided they have to
point to the same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' user ID for which to clear
conversation. Optional, caller
+ Optional. External 'on-behalf-of' user ID for which to clear
conversation. Optional, caller
user ID used by default. Clearing conversation for other
users from the same company
requires administrative privileges. If both user ID and
external 'on-behalf-of' user ID are
provided they have to point to the same NLPCraft user. Note
that if only external 'on-behalf-of'
@@ -129,24 +129,24 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
mdlId:
type: string
maxLength: 32
- description: Data model ID for which to clear dialog flow
+ description: Data model ID for which to clear dialog flow.
usrId:
type: integer
format: int64
description: >-
- User ID for which to clear dialog flow. Optional, caller
user ID used by default.
+ Optional. User ID for which to clear dialog flow. Optional,
caller user ID used by default.
Clearing dialog flow for other users from the same company
requires administrative
privileges. If both user ID and external 'on-behalf-of' user
ID are provided they
have to point to the same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' user ID for which to clear dialog
flow. Optional, caller
+ Optional. External 'on-behalf-of' user ID for which to clear
dialog flow. Optional, caller
user ID used by default. Clearing dialog flow for other
users from the same company
requires administrative privileges. If both user ID and
external 'on-behalf-of' user
ID are provided they have to point to the same NLPCraft
user. Note that if only external
@@ -201,17 +201,17 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
mdlId:
type: string
maxLength: 32
- description: ID of the model to run synonym suggestion on
+ description: ID of the model to run synonym suggestion on.
minScore:
type: number
format: double
description: >-
- Minimal score to include into the result (from 0 to 1,
default is 0)
+ Optional. Minimal score to include into the result (from 0
to 1, default is 0).
responses:
'200':
description: Successful operation.
@@ -223,12 +223,12 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
result:
type: object
- description: Synonym suggestion result
+ description: Synonym suggestion result.
'400':
description: Failed operation.
@@ -255,20 +255,20 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
usrId:
type: integer
format: int64
description: >-
- User ID for which to check the results. Optional, caller
user ID used by default.
+ Optional. User ID for which to check the results. Optional,
caller user ID used by default.
Checking results for other users from the same company
requires administrative privileges. If
both user ID and external 'on-behalf-of' user ID are
provided they have to point to the
same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' user ID for which to check the
results. Optional, caller
+ Optional. External 'on-behalf-of' user ID for which to check
the results. Optional, caller
user ID used by default. Checking results for other users
from the same company requires
administrative privileges. If both user ID and external
'on-behalf-of' user ID are provided
they have to point to the same NLPCraft user. Note that if
only external 'on-behalf-of'
@@ -279,12 +279,13 @@ paths:
items:
type: string
description: >-
- Optional list of server request IDs to check - by default,
all current user requests will be returned.
+ Optional. List of server request IDs to check - by default,
all current user requests will be returned.
Note, there won't be any errors if invalid server requests
IDs are provided (safely ignored instead).
maxRows:
type: integer
format: int64
- description: Optional maximum number of returned items - by
default all items will be returned
+ description: >-
+ Optional. Maximum number of returned items - by default all
items will be returned.
responses:
'200':
description: Successful operation.
@@ -296,7 +297,7 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
states:
@@ -314,28 +315,28 @@ paths:
properties:
srvReqId:
type: string
- description: Server request ID
+ description: Server request ID.
txt:
type: string
- description: Original request text
+ description: Original request text.
usrId:
type: integer
format: int64
- description: ID of the user that submitted the request
+ description: ID of the user that submitted the request.
intentId:
type: string
- description: ID of the intent
+ description: ID of the intent.
mdlId:
type: string
- description: ID of the model
+ description: ID of the model.
probeId:
type: string
- description: ID of the data probe
+ description: ID of the data probe.
status:
type: string
description: >-
Current status of this request (QRY_READY indicates
that
- result - error or ok - is ready)
+ result - error or ok - is ready).
enum:
- QRY_ENLISTED
- QRY_READY
@@ -344,19 +345,19 @@ paths:
description: >-
Optional result type if returned by model (provided
only
if status is QRY_READY and processing was not rejected
- or terminated due to an exception)
+ or terminated due to an exception).
resBody:
type: object
description: >-
Optional body (string or JSON object) of the result if
returned by model
(provided only if status is QRY_READY and processing
was
- not rejected or terminated due to an exception)
+ not rejected or terminated due to an exception).
error:
type: string
description: >-
Optional error if returned by model (provided only if
status is QRY_READY and processing was rejected or
- terminated due to an exception)
+ terminated due to an exception).
errorCode:
type: integer
format: int32
@@ -381,7 +382,7 @@ paths:
10012 - Sentence is too long.
logHolder:
type: object
- description: Optional logger data holder as JSON object
+ description: Optional logger data holder as JSON object.
'400':
description: Failed operation.
schema:
@@ -410,20 +411,20 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
usrId:
type: integer
format: int64
description: >-
- ID of the user whose requests to cancel. Optional, caller
user ID used by default.
+ Optional. ID of the user whose requests to cancel. Optional,
caller user ID used by default.
Cancelling requests for other users from the same company
requires administrative privileges. If
both user ID and external 'on-behalf-of' user ID are
provided they have to point to the
same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' ID of the user whose requests to
cancel. Optional, caller
+ Optional. External 'on-behalf-of' ID of the user whose
requests to cancel. Optional, caller
user ID used by default. Cancelling requests for other users
from the same company requires
administrative privileges. If both user ID and external
'on-behalf-of' user ID are provided
they have to point to the same NLPCraft user. Note that if
only external 'on-behalf-of'
@@ -434,7 +435,7 @@ paths:
items:
type: string
description: >-
- Server IDs of the requests to cancel. Optional, all current
user requests will be cancelled by default.
+ Optional. Server IDs of the requests to cancel. Optional,
all current user requests will be cancelled by default.
Note, there aren't errors even if invalid server requests
identifiers provided as arguments.
responses:
'200':
@@ -468,20 +469,20 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
usrId:
type: integer
format: int64
description: >-
- ID of the user submitting the question. Optional, caller
user ID used by default.
+ Optional. ID of the user submitting the question. Optional,
caller user ID used by default.
Submitting questions for other users from the same company
requires administrative privileges. If
both user ID and external 'on-behalf-of' user ID are
provided they have to point to the
same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' ID of the user submitting the
question. Optional, caller
+ Optional. External 'on-behalf-of' ID of the user submitting
the question. Optional, caller
user ID used by default. Submitting questions for other
users from the same company requires
administrative privileges. If both user ID and external
'on-behalf-of' user ID are provided
they have to point to the same NLPCraft user. Note that if
only external 'on-behalf-of' user ID
@@ -489,7 +490,7 @@ paths:
maxLength: 64
txt:
type: string
- description: Text of the question
+ description: Text of the question.
maxLength: 1024
mdlId:
type: string
@@ -499,10 +500,11 @@ paths:
data:
type: object
description: >-
- Additional user-defined JSON data to be passed along with
the request with maximum
- JSON length of 512000 bytes
+ Optional. Additional user-defined JSON data to be passed
along with the request with maximum
+ JSON length of 512000 bytes.
enableLog:
- description: Flag to enable detailed processing log to be
returned with the result
+ description: >-
+ Optional. Flag to enable detailed processing log to be
returned with the result.
type: boolean
responses:
'200':
@@ -515,12 +517,12 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
srvReqId:
type: string
- description: Server ID assigned to the new processing request
+ description: Server ID assigned to the new processing request.
'400':
description: Failed operation.
schema:
@@ -548,20 +550,20 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
usrId:
type: integer
format: int64
description: >-
- ID of the user submitting the question. Optional, caller
user ID used by default.
+ Optional. ID of the user submitting the question. Optional,
caller user ID used by default.
Submitting questions for other users from the same company
requires administrative privileges. If
both user ID and external 'on-behalf-of' user ID are
provided they have to point to the
same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' ID of the user submitting the
question. Optional, caller
+ Optional. External 'on-behalf-of' ID of the user submitting
the question. Optional, caller
user ID used by default. Submitting questions for other
users from the same company requires
administrative privileges. If both user ID and external
'on-behalf-of' user ID are provided
they have to point to the same NLPCraft user. Note that if
only external 'on-behalf-of' user ID
@@ -569,7 +571,7 @@ paths:
maxLength: 64
txt:
type: string
- description: Text of the question
+ description: Text of the question.
maxLength: 1024
mdlId:
type: string
@@ -579,9 +581,10 @@ paths:
data:
type: object
description: >-
- Additional sentence JSON data with maximum JSON length of
512000 bytes
+ Optional. Additional sentence JSON data with maximum JSON
length of 512000 bytes.
enableLog:
- description: Flag to enable detailed processing log to be
returned with the result
+ description: >-
+ Optional. Flag to enable detailed processing log to be
returned with the result.
type: boolean
responses:
'200':
@@ -610,28 +613,28 @@ paths:
properties:
srvReqId:
type: string
- description: Server request ID
+ description: Server request ID.
txt:
type: string
- description: Original request text
+ description: Original request text.
usrId:
type: integer
format: int64
- description: ID of the user that submitted the request
+ description: ID of the user that submitted the request.
intentId:
type: string
- description: ID of the intent
+ description: ID of the intent.
mdlId:
type: string
- description: ID of the model
+ description: ID of the model.
probeId:
type: string
- description: ID of the data probe
+ description: ID of the data probe.
status:
type: string
description: >-
Current status of this request (QRY_READY indicates that
- result - error or ok - is ready)
+ result - error or ok - is ready).
enum:
- QRY_ENLISTED
- QRY_READY
@@ -640,19 +643,19 @@ paths:
description: >-
Optional result type if returned by model (provided only
if status is QRY_READY and processing was not rejected
- or terminated due to an exception)
+ or terminated due to an exception).
resBody:
type: object
description: >-
Optional body (string or JSON object) of the result if
returned by model
(provided only if status is QRY_READY and processing was
- not rejected or terminated due to an exception)
+ not rejected or terminated due to an exception).
error:
type: string
description: >-
Optional error if returned by model (provided only if
status is QRY_READY and processing was rejected or
- terminated due to an exception)
+ terminated due to an exception).
errorCode:
type: integer
format: int32
@@ -661,7 +664,7 @@ paths:
of 'error' field is present.
logHolder:
type: object
- description: Optional logger data holder as JSON object
+ description: Optional logger data holder as JSON object.
'400':
description: Failed operation.
schema:
@@ -685,20 +688,20 @@ paths:
properties:
acsTok:
maxLength: 256
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
type: string
id:
type: integer
format: int64
description: >-
- ID of the user. Optional, caller user ID used by default.
+ Optional. ID of the user. Optional, caller user ID used by
default.
Getting information about other users from the same company
requires administrative privileges. If
both user ID and external 'on-behalf-of' user ID are
provided they have to point to the
same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' ID of the user. Optional, caller
+ Optional. External 'on-behalf-of' ID of the user. Optional,
caller
user ID used by default. Getting information for other users
from the same company requires
administrative privileges. If both user ID and external
'on-behalf-of' user ID are provided
they have to point to the same NLPCraft user.
@@ -715,34 +718,34 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
id:
- description: User ID
+ description: User ID.
type: integer
format: int64
email:
- description: User email
+ description: User email.
type: string
usrExtId:
- description: User external 'on-behalf-of' ID
+ description: User external 'on-behalf-of' ID.
type: string
firstName:
- description: User first or given name
+ description: User first or given name.
type: string
lastName:
- description: User last name
+ description: User last name.
type: string
avatarUrl:
- description: User avatar URL
+ description: User avatar URL.
type: string
isAdmin:
- description: Whether or not user has Administrative privileges
+ description: Whether or not user has Administrative privileges.
type: boolean
properties:
type: object
- description: Additional user properties
+ description: Additional user properties.
additionalProperties:
type: string
'400':
@@ -768,7 +771,7 @@ paths:
properties:
acsTok:
maxLength: 256
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
type: string
responses:
'200':
@@ -781,7 +784,7 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
users:
@@ -797,26 +800,26 @@ paths:
type: integer
format: int64
email:
- description: User email
+ description: User email.
type: string
usrExtId:
- description: User external 'on-behalf-of' ID
+ description: User external 'on-behalf-of' ID.
type: string
firstName:
- description: User first or given name
+ description: User first or given name.
type: string
lastName:
- description: User last name
+ description: User last name.
type: string
avatarUrl:
- description: User avatar URL
+ description: User avatar URL.
type: string
isAdmin:
- description: Whether or not user has Administrative
privileges
+ description: Whether or not user has Administrative
privileges.
type: boolean
properties:
type: object
- description: Additional user properties
+ description: Additional user properties.
additionalProperties:
type: string
'400':
@@ -850,25 +853,25 @@ paths:
maxLength: 256
id:
description: >-
- Optional ID of the user to update. Only administrators can
+ Optional. ID of the user to update. Only administrators can
provide this parameter. Current user ID is used by default.
type: integer
format: int64
firstName:
type: string
- description: User first or given name
+ description: User first or given name.
maxLength: 64
lastName:
type: string
- description: User last name
+ description: User last name.
maxLength: 64
avatarUrl:
type: string
- description: Optional user avatar URL
+ description: Optional. User avatar URL.
maxLength: 512000
properties:
type: object
- description: Additional user properties
+ description: Optional. Additional user properties.
additionalProperties:
type: string
responses:
@@ -905,7 +908,7 @@ paths:
type: string
id:
description: >-
- Optional ID of the user to delete. Only administrators can
+ Optional. ID of the user to delete. Only administrators can
provide this parameter. Current user ID is used by default.
If both user ID
and external 'on-behalf-of' user ID are provided they have
to point to the same NLPCraft user.
type: integer
@@ -913,7 +916,7 @@ paths:
usrExtId:
maxLength: 64
description: >-
- External 'on-behalf-of' ID of the user to delete. Optional,
caller
+ Optional. External 'on-behalf-of' ID of the user to delete.
Optional, caller
user ID used by default. Administrative privileges are
required to delete
other users from the same company. If both user ID and
external 'on-behalf-of' user ID
are provided they have to point to the same NLPCraft user.
@@ -949,15 +952,15 @@ paths:
properties:
acsTok:
maxLength: 256
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
type: string
id:
description: >-
- Optional ID of the user to update - current user ID is used
by default.
+ Optional. ID of the user to update - current user ID is used
by default.
type: integer
format: int64
isAdmin:
- description: Administrative privileges flag to update to
+ description: Administrative privileges flag to update to.
type: boolean
responses:
'200':
@@ -994,13 +997,13 @@ paths:
type: string
id:
description: >-
- Optional ID of the user to reset password. Only admins
+ Optional. ID of the user to reset password. Only admins
can provide this parameter. Current user ID is used by
default.
type: integer
format: int64
newPasswd:
type: string
- description: New user password
+ description: New user password,
maxLength: 64
responses:
'200':
@@ -1035,38 +1038,38 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
email:
type: string
- description: User email
+ description: User email.
maxLength: 64
passwd:
type: string
- description: User password
+ description: User password.
firstName:
type: string
- description: User first or given name
+ description: User first or given name.
maxLength: 64
lastName:
type: string
- description: User last name
+ description: User last name.
maxLength: 64
avatarUrl:
type: string
- description: Optional user avatar URL
+ description: Optional. User avatar URL.
maxLength: 512000
isAdmin:
type: boolean
- description: Admin flag
+ description: Admin flag.
properties:
type: object
- description: Additional user properties
+ description: Optional. Additional user properties.
additionalProperties:
type: string
usrExtId:
type: string
- description: Optional user external 'on-behalf-of' ID. If this
field defined, method tries to find and update existing user.
+ description: Optional. User external 'on-behalf-of' ID. If
this field defined, method tries to find and update existing user.
maxLength: 64
responses:
'200':
@@ -1079,13 +1082,13 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
id:
type: integer
format: int64
- description: ID of the newly created user
+ description: ID of the newly created user.
'400':
description: Failed operation.
schema:
@@ -1109,7 +1112,7 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
responses:
'200':
@@ -1123,33 +1126,33 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
id:
- description: Company ID
+ description: Company ID.
type: integer
format: int64
name:
- description: Company name
+ description: Company name.
type: string
website:
- description: Copmany website
+ description: Copmany website.
type: string
country:
- description: Company country
+ description: Company country.
type: string
region:
- description: Company region
+ description: Company region.
type: string
city:
- description: Company city
+ description: Company city.
type: string
address:
- description: Company address
+ description: Company address.
type: string
postalCode:
- description: Company postal code
+ description: Company postal code.
type: string
'400':
description: Failed operation.
@@ -1181,54 +1184,54 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
name:
type: string
- description: Company name
+ description: Company name.
maxLength: 64
website:
type: string
- description: Optional company website address
+ description: Optional. Company website address.
maxLength: 256
country:
type: string
- description: Optional company country
+ description: Optional. Company country.
maxLength: 32
region:
type: string
- description: Optional company region
+ description: Optional. Company region.
maxLength: 512
city:
type: string
- description: Optional company city
+ description: Optional. Company city.
maxLength: 512
address:
type: string
- description: Optional company address
+ description: Optional. Company address.
maxLength: 512
postalCode:
type: string
- description: Optional company postal code
+ description: Optional. Company postal code.
maxLength: 512
adminEmail:
type: string
- description: Admin user email
+ description: Admin user email.
maxLength: 64
adminPasswd:
type: string
- description: Admin user password
+ description: Admin user password.
adminFirstName:
type: string
- description: Admin user first or given name
+ description: Admin user first or given name.
maxLength: 64
adminLastName:
type: string
- description: Admin user last name
+ description: Admin user last name.
maxLength: 64
adminAvatarUrl:
type: string
- description: Optional admin user avatar URL
+ description: Optional. Admin user avatar URL.
maxLength: 512000
responses:
'200':
@@ -1242,16 +1245,16 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
token:
type: string
- description: Company probes authentication token
+ description: Company probes authentication token.
adminId:
type: integer
format: int64
- description: ID of the newly created admin user
+ description: ID of the newly created admin user.
'400':
description: Failed operation.
schema:
@@ -1278,35 +1281,35 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
name:
type: string
- description: Company name
+ description: Company name.
maxLength: 64
website:
type: string
- description: Optional company website address
+ description: Optional. Company website address.
maxLength: 256
country:
type: string
- description: Optional company country
+ description: Optional. Company country.
maxLength: 32
region:
type: string
- description: Optional company region
+ description: Optional. Company region.
maxLength: 512
city:
type: string
- description: Optional company city
+ description: Optional. Company city.
maxLength: 512
address:
type: string
- description: Optional company address
+ description: Optional. Company address.
maxLength: 512
postalCode:
type: string
- description: Optional company postal code
+ description: Optional. Company postal code.
maxLength: 512
responses:
'200':
@@ -1338,7 +1341,7 @@ paths:
properties:
acsTok:
type: string
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
maxLength: 256
responses:
'200':
@@ -1417,24 +1420,24 @@ paths:
description: Access token obtain via '/signin' call
type: string
usrId:
- description: User ID.
+ description: Optional. User ID.
type: integer
format: int64
usrExtId:
maxLength: 64
- description: External user ID. Note user with given ID will be
created if missing
+ description: Optional. External user ID. Note user with given
ID will be created if missing
type: string
srvReqId:
maxLength: 64
description: Server request ID
type: string
score:
- description: Score. Valid range is between 0 and 1, inclusive
+ description: Score. Valid range is between 0 and 1, inclusive.
type: number
format: double
comment:
maxLength: 1024
- description: Optional feedback comment
+ description: Optional. Feedback comment.
type: string
responses:
'200':
@@ -1447,13 +1450,13 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
id:
type: integer
format: int64
- description: ID of the newly created feedback record
+ description: ID of the newly created feedback record.
'400':
description: Failed operation.
schema:
@@ -1480,7 +1483,7 @@ paths:
properties:
acsTok:
maxLength: 256
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
type: string
id:
description: Feedback record ID to delete.
@@ -1522,14 +1525,14 @@ paths:
type: integer
format: int64
description: >-
- ID of the user to get feedback records for. Optional, caller
user ID used by default.
+ Optional. ID of the user to get feedback records for.
Optional, caller user ID used by default.
Getting feedback for other users requires administrative
privileges. If
both user ID and external 'on-behalf-of' user ID are
provided they have to point to the
same NLPCraft user.
usrExtId:
type: string
description: >-
- External 'on-behalf-of' ID of the user to get feedback
records for. Optional, caller
+ Optional. External 'on-behalf-of' ID of the user to get
feedback records for. Optional, caller
user ID used by default. Getting feedback for other users
from the same company requires
administrative privileges. If both user ID and external
'on-behalf-of' user ID are provided
they have to point to the same NLPCraft user. Note that if
only external 'on-behalf-of'
@@ -1537,7 +1540,7 @@ paths:
maxLength: 64
srvReqId:
maxLength: 256
- description: Server request ID
+ description: Optional. Server request ID
type: string
responses:
'200':
@@ -1565,27 +1568,27 @@ paths:
- createTstamp
properties:
id:
- description: Feedback ID
+ description: Feedback ID.
type: integer
format: int64
srvReqId:
- description: Server request ID
+ description: Server request ID.
type: string
usrId:
- description: User ID
+ description: User ID.
type: integer
format: int64
score:
- description: Feedback score
+ description: Feedback score.
type: number
format: double
comment:
- description: Feedback comment
+ description: Feedback comment.
type: string
createTstamp:
type: integer
format: int64
- description: Creation UTC/GMT timestamp of the request
+ description: Creation UTC/GMT timestamp of the request.
'400':
description: Failed operation.
schema:
@@ -1631,7 +1634,7 @@ paths:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
acsTok:
@@ -1695,7 +1698,7 @@ paths:
properties:
acsTok:
maxLength: 256
- description: Access token obtain via '/signin' call
+ description: Access token obtain via '/signin' call.
type: string
responses:
'200':
@@ -1737,62 +1740,62 @@ paths:
- models
properties:
probeToken:
- description: Probe token
+ description: Probe token.
type: string
probeId:
- description: Probe ID (user defined ID)
+ description: Probe ID (user defined ID).
type: string
probeGuid:
- description: Probe GUID (globally unique internal ID)
+ description: Probe GUID (globally unique internal ID).
type: string
probeApiVersion:
- description: Probe API version
+ description: Probe API version.
type: string
probeApiDate:
- description: Probe API date
+ description: Probe API date.
type: string
osVersion:
- description: OS version
+ description: OS version.
type: string
osName:
- description: OS name
+ description: OS name.
type: string
osArch:
- description: OS architecture
+ description: OS architecture.
type: string
startTstamp:
description: Start time in UTC.
type: integer
format: int64
tmzId:
- description: Timezone ID
+ description: Timezone ID.
type: string
tmzAbbr:
- description: Timezone abbreviation
+ description: Timezone abbreviation.
type: string
tmzName:
- description: Timezone name
+ description: Timezone name.
type: string
userName:
- description: User name
+ description: User name.
type: string
javaVersion:
- description: Java version
+ description: Java version.
type: string
javaVendor:
- description: Java vendor
+ description: Java vendor.
type: string
hostName:
- description: Host name
+ description: Host name.
type: string
hostAddr:
- description: Host address
+ description: Host address.
type: string
macAddr:
- description: MAC address
+ description: MAC address.
type: string
models:
- description: Models
+ description: Models.
type: array
items:
type: object
@@ -1802,16 +1805,16 @@ paths:
- version
properties:
id:
- description: Model ID (unique, immutable ID)
+ description: Model ID (unique, immutable ID).
type: string
name:
- description: Model name (descriptive name of this
model)
+ description: Model name (descriptive name of this
model).
type: string
version:
description: Model version
type: string
enabledBuiltInTokens:
- description: Built-in tokens enabled (requested)
for this data model
+ description: Built-in tokens enabled (requested)
for this data model.
type: array
items:
type: string
@@ -1827,7 +1830,7 @@ definitions:
properties:
status:
type: string
- description: Status code of this operation
+ description: Status code of this operation.
enum:
- API_OK
Error:
@@ -1837,7 +1840,7 @@ definitions:
properties:
status:
type: string
- description: Status code of this error
+ description: Status code of this error.
enum:
- NC_INVALID_ACCESS_TOKEN
- NC_SIGNIN_FAILURE
@@ -1848,4 +1851,4 @@ definitions:
- NC_ERROR
reason:
type: string
- description: Reason for this error
+ description: Reason for this error.
