Microsoft Cognitive Language Service - Question Answering Authoring (preview:2025-05-15)

2025/05/05 • 21 new methods

QuestionAnsweringProjects_ListProjects (new)
Description Gets all projects for a user.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects
{
api-version: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
projectName: string ,
description: string ,
language: string ,
multilingualResource: boolean ,
settings:
{
defaultAnswer: string ,
}
,
createdDateTime: string ,
lastModifiedDateTime: string ,
lastDeployedDateTime: string ,
configureSemanticRanking: boolean ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetProjectDetails (new)
Description Get the requested project metadata.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}
{
api-version: string ,
projectName: string ,
}

⚐ Response (200)

{
projectName: string ,
description: string ,
language: string ,
multilingualResource: boolean ,
settings:
{
defaultAnswer: string ,
}
,
createdDateTime: string ,
lastModifiedDateTime: string ,
lastDeployedDateTime: string ,
configureSemanticRanking: boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_CreateProject (new)
Description Create or update a project.
Reference Link ¶

⚼ Request

PATCH:  /authoring/query-knowledgebases/projects/{projectName}
{
api-version: string ,
projectName: string ,
body:
{
description: string ,
language: string ,
multilingualResource: boolean ,
settings:
{
defaultAnswer: string ,
}
,
configureSemanticRanking: boolean ,
}
,
}

⚐ Response (200)

{
projectName: string ,
description: string ,
language: string ,
multilingualResource: boolean ,
settings:
{
defaultAnswer: string ,
}
,
createdDateTime: string ,
lastModifiedDateTime: string ,
lastDeployedDateTime: string ,
configureSemanticRanking: boolean ,
}

⚐ Response (201)

{
projectName: string ,
description: string ,
language: string ,
multilingualResource: boolean ,
settings:
{
defaultAnswer: string ,
}
,
createdDateTime: string ,
lastModifiedDateTime: string ,
lastDeployedDateTime: string ,
configureSemanticRanking: boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_DeleteProject (new)
Description Delete the project.
Reference Link ¶

⚼ Request

DELETE:  /authoring/query-knowledgebases/projects/{projectName}
{
api-version: string ,
projectName: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_Export (new)
Description Export project metadata and assets.
Reference Link ¶

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/:export
{
api-version: string ,
projectName: string ,
format: string ,
assetKind: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_Import (new)
Description Import project assets.
Reference Link ¶

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/:import
{
api-version: string ,
projectName: string ,
format: string ,
assetKind: string ,
body:
{
metadata:
{
projectName: string ,
description: string ,
language: string ,
multilingualResource: boolean ,
settings:
{
defaultAnswer: string ,
}
,
createdDateTime: string ,
lastModifiedDateTime: string ,
lastDeployedDateTime: string ,
configureSemanticRanking: boolean ,
}
,
assets:
{
synonyms:
[
{
alterations:
[
string ,
]
,
}
,
]
,
qnas:
[
{
id: integer ,
answer: string ,
source: string ,
questions:
[
string ,
]
,
metadata: object ,
dialog:
{
isContextOnly: boolean ,
prompts:
[
{
displayOrder: integer ,
qnaId: integer ,
qna:
{
id: integer ,
answer: string ,
source: string ,
questions:
[
string ,
]
,
metadata: object ,
dialog: string ,
activeLearningSuggestions:
[
{
clusterHead: string ,
suggestedQuestions:
[
{
question: string ,
userSuggestedCount: integer ,
autoSuggestedCount: integer ,
}
,
]
,
}
,
]
,
}
,
displayText: string ,
}
,
]
,
}
,
activeLearningSuggestions:
[
{
clusterHead: string ,
suggestedQuestions:
[
{
question: string ,
userSuggestedCount: integer ,
autoSuggestedCount: integer ,
}
,
]
,
}
,
]
,
lastUpdatedDateTime: string ,
sourceDisplayName: string ,
}
,
]
,
}
,
fileUri: string ,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_ListDeployments (new)
Description List all deployments of a project.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/deployments
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
deploymentName: string ,
lastDeployedDateTime: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_DeployProject (new)
Description Deploy project to production.
Reference Link ¶

⚼ Request

PUT:  /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetDeployStatus (new)
Description Gets the status of a Deploy job.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
{
api-version: string ,
projectName: string ,
deploymentName: string ,
jobId: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
expirationDateTime: string ,
jobId: string ,
lastUpdatedDateTime: string ,
status: enum ,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetExportStatus (new)
Description Gets the status of an Export job, once job completes, returns the project metadata, and assets.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
expirationDateTime: string ,
jobId: string ,
lastUpdatedDateTime: string ,
status: enum ,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
resultUrl: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_AddFeedback (new)
Description Update Active Learning feedback.
Reference Link ¶

⚼ Request

POST:  /authoring/query-knowledgebases/projects/{projectName}/feedback
{
api-version: string ,
projectName: string ,
body:
{
records:
[
{
userId: string ,
userQuestion: string ,
qnaId: integer ,
}
,
]
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetImportStatus (new)
Description Gets the status of an Import job.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
expirationDateTime: string ,
jobId: string ,
lastUpdatedDateTime: string ,
status: enum ,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetQnas (new)
Description Gets all the QnAs of a project.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/qnas
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
source: string ,
}

⚐ Response (200)

{
value:
[
{
id: integer ,
answer: string ,
source: string ,
questions:
[
string ,
]
,
metadata: object ,
dialog:
{
isContextOnly: boolean ,
prompts:
[
{
displayOrder: integer ,
qnaId: integer ,
qna:
{
id: integer ,
answer: string ,
source: string ,
questions:
[
string ,
]
,
metadata: object ,
dialog: string ,
activeLearningSuggestions:
[
{
clusterHead: string ,
suggestedQuestions:
[
{
question: string ,
userSuggestedCount: integer ,
autoSuggestedCount: integer ,
}
,
]
,
}
,
]
,
}
,
displayText: string ,
}
,
]
,
}
,
activeLearningSuggestions:
[
{
clusterHead: string ,
suggestedQuestions:
[
{
question: string ,
userSuggestedCount: integer ,
autoSuggestedCount: integer ,
}
,
]
,
}
,
]
,
lastUpdatedDateTime: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_UpdateQnas (new)
Description Updates the QnAs of a project.
Reference Link ¶

⚼ Request

PATCH:  /authoring/query-knowledgebases/projects/{projectName}/qnas
{
api-version: string ,
projectName: string ,
body:
{
op: enum ,
value:
{
id: integer ,
answer: string ,
source: string ,
questions:
[
string ,
]
,
metadata: object ,
dialog: string ,
activeLearningSuggestions:
[
{
clusterHead: string ,
suggestedQuestions:
[
{
question: string ,
userSuggestedCount: integer ,
autoSuggestedCount: integer ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetUpdateQnasStatus (new)
Description Gets the status of update QnAs job.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
expirationDateTime: string ,
jobId: string ,
lastUpdatedDateTime: string ,
status: enum ,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetSources (new)
Description Gets all the sources of a project.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/sources
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
displayName: string ,
source: string ,
sourceUri: string ,
sourceKind: enum ,
contentStructureKind: enum ,
lastUpdatedDateTime: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_UpdateSources (new)
Description Updates the sources of a project.
Reference Link ¶

⚼ Request

PATCH:  /authoring/query-knowledgebases/projects/{projectName}/sources
{
api-version: string ,
projectName: string ,
body:
{
op: enum ,
value:
{
displayName: string ,
source: string ,
sourceUri: string ,
sourceKind: enum ,
contentStructureKind: enum ,
refresh: boolean ,
}
,
}
,
}

⚐ Response (202)

{
operation-location: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetUpdateSourcesStatus (new)
Description Gets the status of update sources job.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}
{
api-version: string ,
projectName: string ,
jobId: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
expirationDateTime: string ,
jobId: string ,
lastUpdatedDateTime: string ,
status: enum ,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetSynonyms (new)
Description Gets all the synonyms of a project.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/{projectName}/synonyms
{
api-version: string ,
projectName: string ,
top: integer ,
skip: integer ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
alterations:
[
string ,
]
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_UpdateSynonyms (new)
Description Updates all the synonyms of a project.
Reference Link ¶

⚼ Request

PUT:  /authoring/query-knowledgebases/projects/{projectName}/synonyms
{
api-version: string ,
projectName: string ,
body:
{
value:
[
{
alterations:
[
string ,
]
,
}
,
]
,
nextLink: string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}
QuestionAnsweringProjects_GetDeleteStatus (new)
Description Gets the status of a Project delete job.
Reference Link ¶

⚼ Request

GET:  /authoring/query-knowledgebases/projects/deletion-jobs/{jobId}
{
api-version: string ,
jobId: string ,
}

⚐ Response (200)

{
createdDateTime: string ,
expirationDateTime: string ,
jobId: string ,
lastUpdatedDateTime: string ,
status: enum ,
errors:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: enum ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: enum ,
message: string ,
details: object ,
target: string ,
innererror: string ,
}
,
}
,
}
,
}