POST api/AzureAI/{ProjectName}/QuestionAnswering

Request Information

URI Parameters

Name	Description	Type	Additional information
ProjectName		string	Required

Body Parameters

QARequest

Name	Description	Type	Additional information
question		string	None.

Request Formats

application/json, text/json

Sample:

{
  "question": "sample string 1"
}

application/xml, text/xml

Sample:

<AzureAIController.QARequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iMOE_Back_End.Controllers">
  <question>sample string 1</question>
</AzureAIController.QARequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AnswerResponse

Name	Description	Type	Additional information
answers			None.

Response Formats

application/json, text/json

Sample:

{
  "answers": [
    {
      "questions": [
        "sample string 1",
        "sample string 2"
      ],
      "answer": "sample string 1",
      "confidenceScore": 2.1,
      "id": 3,
      "source": "sample string 4",
      "metadata": {
        "system_metadata_qna_edited_manually": "sample string 1"
      },
      "dialog": {
        "isContextOnly": true,
        "prompts": [
          {},
          {}
        ]
      }
    },
    {
      "questions": [
        "sample string 1",
        "sample string 2"
      ],
      "answer": "sample string 1",
      "confidenceScore": 2.1,
      "id": 3,
      "source": "sample string 4",
      "metadata": {
        "system_metadata_qna_edited_manually": "sample string 1"
      },
      "dialog": {
        "isContextOnly": true,
        "prompts": [
          {},
          {}
        ]
      }
    }
  ]
}

application/xml, text/xml

Sample:

<AzureAIClass.AnswerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iMOE_Back_End">
  <answers>
    <AzureAIClass.Answer>
      <answer>sample string 1</answer>
      <confidenceScore>2.1</confidenceScore>
      <dialog>
        <isContextOnly>true</isContextOnly>
        <prompts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </prompts>
      </dialog>
      <id>3</id>
      <metadata>
        <system_metadata_qna_edited_manually>sample string 1</system_metadata_qna_edited_manually>
      </metadata>
      <questions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </questions>
      <source>sample string 4</source>
    </AzureAIClass.Answer>
    <AzureAIClass.Answer>
      <answer>sample string 1</answer>
      <confidenceScore>2.1</confidenceScore>
      <dialog>
        <isContextOnly>true</isContextOnly>
        <prompts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:anyType />
          <d5p1:anyType />
        </prompts>
      </dialog>
      <id>3</id>
      <metadata>
        <system_metadata_qna_edited_manually>sample string 1</system_metadata_qna_edited_manually>
      </metadata>
      <questions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </questions>
      <source>sample string 4</source>
    </AzureAIClass.Answer>
  </answers>
</AzureAIClass.AnswerResponse>