QnAMaker Client (preview:v5.0.2)

2025/10/21 • 20 deleted methods

EndpointSettings_GetSettings (removed)
Description :  Gets endpoint settings for an endpoint.
Reference :  Link ¶

⚼ Request

GET:  /endpointSettings
{}

⚐ Response (200)

{
activeLearning:
{
Description: Active Learning settings of the endpoint. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
EndpointSettings_UpdateSettings (removed)
Description :  Updates endpoint settings for an endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /endpointSettings
{
endpointSettingsPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
activeLearning:
{
Description: Active Learning settings of the endpoint. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
EndpointKeys_GetKeys (removed)
Description :  Gets endpoint keys for an endpoint
Reference :  Link ¶

⚼ Request

GET:  /endpointkeys
{}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
Required: False ,
}
string ,
language:
{
Description: Language setting of runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
EndpointKeys_RefreshKeys (removed)
Description :  Re-generates an endpoint key.
Reference :  Link ¶

⚼ Request

PATCH:  /endpointkeys/{keyType}
{
keyType:
{
Description: Type of Key ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryEndpointKey:
{
Description: Primary Access Key. ,
Required: False ,
}
string ,
secondaryEndpointKey:
{
Description: Secondary Access Key. ,
Required: False ,
}
string ,
installedVersion:
{
Description: Current version of runtime. ,
Required: False ,
}
string ,
lastStableVersion:
{
Description: Latest version of runtime. ,
Required: False ,
}
string ,
language:
{
Description: Language setting of runtime. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Alterations_Get (removed)
Description :  Download alterations from runtime.
Reference :  Link ¶

⚼ Request

GET:  /alterations
{}

⚐ Response (200)

{
wordAlterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
{
alterations:
{
Description: Words that are synonymous with each other. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Alterations_Replace (removed)
Description :  Replace alterations data.
Reference :  Link ¶

⚼ Request

PUT:  /alterations
{
wordAlterations:
{
Description: New alterations data. ,
Required: True ,
}
{
wordAlterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
{
alterations:
{
Description: Words that are synonymous with each other. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Alterations_GetAlterationsForKb (removed)
Description :  Download alterations per Knowledgebase (QnAMaker Managed).
Reference :  Link ¶

⚼ Request

GET:  /alterations/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
wordAlterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
{
alterations:
{
Description: Words that are synonymous with each other. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Alterations_ReplaceAlterationsForKb (removed)
Description :  Replace alterations data per Knowledgebase (QnAMaker Managed).
Reference :  Link ¶

⚼ Request

PUT:  /alterations/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
wordAlterations:
{
Description: New alterations data. ,
Required: True ,
}
{
wordAlterations:
{
Description: Collection of word alterations. ,
Required: True ,
}
[
{
alterations:
{
Description: Words that are synonymous with each other. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_ListAll (removed)
Description :  Gets all knowledgebases for a user.
Reference :  Link ¶

⚼ Request

GET:  /knowledgebases
{}

⚐ Response (200)

{
knowledgebases:
{
Description: Collection of knowledgebase records. ,
Required: False ,
}
[
{
id:
{
Description: Unique id that identifies a knowledgebase. ,
Required: False ,
}
string ,
hostName:
{
Description: URL host name at which the knowledgebase is hosted. ,
Required: False ,
}
string ,
lastAccessedTimestamp:
{
Description: Time stamp at which the knowledgebase was last accessed (UTC). ,
Required: False ,
}
string ,
lastChangedTimestamp:
{
Description: Time stamp at which the knowledgebase was last modified (UTC). ,
Required: False ,
}
string ,
lastPublishedTimestamp:
{
Description: Time stamp at which the knowledgebase was last published (UTC). ,
Required: False ,
}
string ,
name:
{
Description: Friendly name of the knowledgebase. ,
Required: False ,
}
string ,
userId:
{
Description: User who created / owns the knowledgebase. ,
Required: False ,
}
string ,
urls:
{
Description: URL sources from which Q-A were extracted and added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
sources:
{
Description: Custom sources from which Q-A were extracted or explicitly added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Operations_GetDetails (removed)
Description :  Gets details of a specific long running operation.
Reference :  Link ¶

⚼ Request

GET:  /operations/{operationId}
{
operationId:
{
Description: Operation id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retryafter:
{
Description: Indicates how long the client should wait before sending a follow up request. The header will be present only if the operation is running or has not started yet. ,
}
integer ,
}
,
$schema:
{
Description: Record to track long running operation. ,
}
{
operationState:
{
Description: Operation state. ,
Enum:
{
Failed: No description available. ,
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Timestamp when the operation was created. ,
Required: False ,
}
string ,
lastActionTimestamp:
{
Description: Timestamp when the current state was entered. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Relative URI to the target resource location for completed resources. ,
Required: False ,
}
string ,
userId:
{
Description: User Id ,
Required: False ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: False ,
}
string ,
errorResponse:
{
Description: Error details in case of failures. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_GetDetails (removed)
Description :  Gets details of a specific knowledgebase.
Reference :  Link ¶

⚼ Request

GET:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Unique id that identifies a knowledgebase. ,
Required: False ,
}
string ,
hostName:
{
Description: URL host name at which the knowledgebase is hosted. ,
Required: False ,
}
string ,
lastAccessedTimestamp:
{
Description: Time stamp at which the knowledgebase was last accessed (UTC). ,
Required: False ,
}
string ,
lastChangedTimestamp:
{
Description: Time stamp at which the knowledgebase was last modified (UTC). ,
Required: False ,
}
string ,
lastPublishedTimestamp:
{
Description: Time stamp at which the knowledgebase was last published (UTC). ,
Required: False ,
}
string ,
name:
{
Description: Friendly name of the knowledgebase. ,
Required: False ,
}
string ,
userId:
{
Description: User who created / owns the knowledgebase. ,
Required: False ,
}
string ,
urls:
{
Description: URL sources from which Q-A were extracted and added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
sources:
{
Description: Custom sources from which Q-A were extracted or explicitly added to the knowledgebase. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Delete (removed)
Description :  Deletes the knowledgebase and all its data.
Reference :  Link ¶

⚼ Request

DELETE:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Publish (removed)
Description :  Publishes all changes in test index of a knowledgebase to its prod index.
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Replace (removed)
Description :  Replace knowledgebase contents.
Reference :  Link ¶

⚼ Request

PUT:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
replaceKb:
{
Description: An instance of ReplaceKbDTO which contains list of qnas to be uploaded ,
Required: True ,
}
{
qnAList:
{
Description: List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted. ,
Required: True ,
}
[
{
id:
{
Description: Unique id for the Q-A. ,
Format: int32 ,
Required: False ,
}
integer ,
answer:
{
Description: Answer text ,
Required: True ,
}
string ,
source:
{
Description: Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: True ,
}
[
string ,
]
,
metadata:
{
Description: List of metadata associated with the answer. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context of a QnA ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Timestamp when the QnA was last updated. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Update (removed)
Description :  Asynchronous operation to modify a knowledgebase.
Reference :  Link ¶

⚼ Request

PATCH:  /knowledgebases/{kbId}
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
updateKb:
{
Description: Post body of the request. ,
Required: True ,
}
{
add:
{
Description: An instance of CreateKbInputDTO for add operation ,
Required: False ,
}
string ,
delete:
{
Description: An instance of DeleteKbContentsDTO for delete Operation ,
Required: False ,
}
string ,
update:
{
Description: An instance of UpdateKbContentsDTO for Update Operation ,
Required: False ,
}
string ,
enableHierarchicalExtraction:
{
Description: Enable hierarchical extraction of Q-A from files and urls. The value set during KB creation will be used if this field is not present. ,
Required: False ,
}
boolean ,
defaultAnswerUsedForExtraction:
{
Description: Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: Relative URI to the target location of the asynchronous operation. Client should poll this resource to get status of the operation. ,
}
string ,
}
,
$schema:
{
Description: Record to track long running operation. ,
}
{
operationState:
{
Description: Operation state. ,
Enum:
{
Failed: No description available. ,
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Timestamp when the operation was created. ,
Required: False ,
}
string ,
lastActionTimestamp:
{
Description: Timestamp when the current state was entered. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Relative URI to the target resource location for completed resources. ,
Required: False ,
}
string ,
userId:
{
Description: User Id ,
Required: False ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: False ,
}
string ,
errorResponse:
{
Description: Error details in case of failures. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Create (removed)
Description :  Asynchronous operation to create a new knowledgebase.
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/create
{
createKbPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
name:
{
Description: Friendly name for the knowledgebase. ,
Required: True ,
}
string ,
qnaList:
{
Description: List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted. ,
Required: False ,
}
[
{
id:
{
Description: Unique id for the Q-A. ,
Format: int32 ,
Required: False ,
}
integer ,
answer:
{
Description: Answer text ,
Required: True ,
}
string ,
source:
{
Description: Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: True ,
}
[
string ,
]
,
metadata:
{
Description: List of metadata associated with the answer. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context of a QnA ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Timestamp when the QnA was last updated. ,
Required: False ,
}
string ,
}
,
]
,
urls:
{
Description: List of URLs to be used for extracting Q-A. ,
Required: False ,
}
[
string ,
]
,
files:
{
Description: List of files from which to Extract Q-A. ,
Required: False ,
}
[
{
fileName:
{
Description: File name. Supported file types are ".tsv", ".pdf", ".txt", ".docx", ".xlsx". ,
Required: True ,
}
string ,
fileUri:
{
Description: Public URI of the file. ,
Required: True ,
}
string ,
isUnstructured:
{
Description: Optional Flag to specify if the given file is Unstructured. ,
Required: False ,
}
boolean ,
}
,
]
,
enableHierarchicalExtraction:
{
Description: Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present. ,
Required: False ,
}
boolean ,
defaultAnswerUsedForExtraction:
{
Description: Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True. ,
Required: False ,
}
string ,
language:
{
Description: Language of the knowledgebase. Please find the list of supported languages here. ,
Required: False ,
}
string ,
enableMultipleLanguages:
{
Description: Set to true to enable creating KBs in different languages for the same resource. ,
Required: False ,
}
boolean ,
defaultAnswer:
{
Description: Default answer sent to user if no good match is found in the KB. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
operationState:
{
Description: Operation state. ,
Enum:
{
Failed: No description available. ,
NotStarted: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
createdTimestamp:
{
Description: Timestamp when the operation was created. ,
Required: False ,
}
string ,
lastActionTimestamp:
{
Description: Timestamp when the current state was entered. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: Relative URI to the target resource location for completed resources. ,
Required: False ,
}
string ,
userId:
{
Description: User Id ,
Required: False ,
}
string ,
operationId:
{
Description: Operation Id. ,
Required: False ,
}
string ,
errorResponse:
{
Description: Error details in case of failures. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Download (removed)
Description :  Download the knowledgebase.
Reference :  Link ¶

⚼ Request

GET:  /knowledgebases/{kbId}/{environment}/qna
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
environment:
{
Description: Specifies whether environment is Test or Prod. ,
Required: True ,
}
string ,
source:
{
Description: The source property filter to apply. ,
Required: False ,
}
string ,
changedSince:
{
Description: The last changed status property filter to apply. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
qnaDocuments:
{
Description: List of answers. ,
Required: False ,
}
[
{
id:
{
Description: Unique id for the Q-A. ,
Format: int32 ,
Required: False ,
}
integer ,
answer:
{
Description: Answer text ,
Required: True ,
}
string ,
source:
{
Description: Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs ,
Required: False ,
}
string ,
questions:
{
Description: List of questions associated with the answer. ,
Required: True ,
}
[
string ,
]
,
metadata:
{
Description: List of metadata associated with the answer. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context of a QnA ,
Required: False ,
}
string ,
lastUpdatedTimestamp:
{
Description: Timestamp when the QnA was last updated. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_GenerateAnswer (removed)
Description :  GenerateAnswer call to query knowledgebase (QnA Maker Managed).
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/{kbId}/generateAnswer
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
generateAnswerPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
qnaId:
{
Description: Exact qnaId to fetch from the knowledgebase, this field takes priority over question. ,
Required: False ,
}
string ,
question:
{
Description: User question to query against the knowledge base. ,
Required: False ,
}
string ,
top:
{
Description: Max number of answers to be returned for the question. ,
Format: int32 ,
Required: False ,
}
integer ,
userId:
{
Description: Unique identifier for the user. ,
Required: False ,
}
string ,
isTest:
{
Description: Query against the test index. ,
Required: False ,
}
boolean ,
scoreThreshold:
{
Description: Minimum threshold score for answers. ,
Required: False ,
}
number ,
context:
{
Description: Context object with previous QnA's information. ,
Required: False ,
}
string ,
rankerType:
{
Description: Optional field. Set to 'QuestionOnly' for using a question only Ranker. ,
Required: False ,
}
string ,
strictFilters:
{
Description: Find QnAs that are associated with the given list of metadata. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
strictFiltersCompoundOperationType:
{
Description: Optional field. Set to 'OR' for using OR operation for strict filters. ,
Enum:
{
AND: No description available. ,
OR: No description available. ,
}
,
Required: False ,
}
enum ,
answerSpanRequest:
{
Description: To configure Answer span prediction feature. ,
Required: False ,
}
string ,
includeUnstructuredSources:
{
Description: Optional Flag to enable Query over Unstructured Sources. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
answers:
{
Description: Represents Search Result list. ,
Required: False ,
}
[
{
questions:
{
Description: List of questions. ,
Required: False ,
}
[
string ,
]
,
answer:
{
Description: Answer. ,
Required: False ,
}
string ,
score:
{
Description: Search result score. ,
Required: False ,
}
number ,
id:
{
Description: Id of the QnA result. ,
Format: int32 ,
Required: False ,
}
integer ,
source:
{
Description: Source of QnA result. ,
Required: False ,
}
string ,
metadata:
{
Description: List of metadata. ,
Required: False ,
}
[
{
name:
{
Description: Metadata name. ,
Required: True ,
}
string ,
value:
{
Description: Metadata value. ,
Required: True ,
}
string ,
}
,
]
,
context:
{
Description: Context object of the QnA ,
Required: False ,
}
object ,
answerSpan:
{
Description: Answer span object of QnA with respect to user's question. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Knowledgebase_Train (removed)
Description :  Train call to add suggestions to knowledgebase (QnAMaker Managed).
Reference :  Link ¶

⚼ Request

POST:  /knowledgebases/{kbId}/train
{
kbId:
{
Description: Knowledgebase id. ,
Required: True ,
}
string ,
trainPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
feedbackRecords:
{
Description: List of feedback records. ,
Required: False ,
}
[
{
userId:
{
Description: Unique identifier for the user. ,
Required: False ,
}
string ,
userQuestion:
{
Description: The suggested question being provided as feedback. ,
Required: False ,
}
string ,
qnaId:
{
Description: The qnaId for which the suggested question is provided as feedback. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}
Prebuilt_GenerateAnswer (removed)
Description :  GenerateAnswer call to query text in documents.
Reference :  Link ¶

⚼ Request

POST:  /generateAnswer
{
prebuiltGenerateAnswerPayload:
{
Description: Post body of the request. ,
Required: True ,
}
{
question:
{
Description: User question to query against the given documents. ,
Required: True ,
}
string ,
documents:
{
Description: Documents to be searched for given question. ,
Required: True ,
}
[
{
id:
{
Description: Unique identifier for the document. ,
Required: True ,
}
string ,
text:
{
Description: Text contents of the document ,
Required: True ,
}
string ,
}
,
]
,
language:
{
Description: (Optional) Language of the documents. This is ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. ,
Required: False ,
}
string ,
}
,
stringIndexType:
{
Description: (Optional) Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: Represents List of Answer Results. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
string ,
}