How to upload a file to QnA Maker knowledge base using API ?

Question

How to upload a file to QnA Maker knowledge base using API ?

SAI 1

Hi, I am using python for the QnA maker services API. My aim is to create knowledge base by uploading a file (.pdf, .docx, etc.). I am referring to following code : create-new-knowledge-base.py . But there is no specification of how to pass file arguments. I am new to Azure services, please can anyone help me with that. Thanks.

Ramr-msft 17,826 Reputation points

2021-07-27T04:01:07.897+00:00

@SAI Thanks for the question. You can create your KB by using the QnAMaker APIs. Please follow the document for API's.
In particular, you can use the Update Knowledge Base operation, which will allow you to add/delete QnA Pairs and / or URLs to an existing knowledge base.

Ramr-msft 17,826

Basically You can use UpdateKbOperationDTO Class listed here: class

but it allows to update KB with files using code instead of the interface.

Below is new code:

QnAMakerClient qnaC = new QnAMakerClient(new ApiKeyServiceClientCredentials(<subscription-key>)) { Endpoint = "https://<your-custom-domain>.cognitiveservices.azure.com"};  
log.LogInformation("Delete-->Start");  
List<string> toDelete = new List<string>();  
toDelete.Add("<my-file>");  
var updateDelete = await qnaC.Knowledgebase.UpdateAsync(kbId, new UpdateKbOperationDTO  
    {  
        // Create JSON of changes ///  
        Add = null,   
        Update = null,   
        Delete = new UpdateKbOperationDTODelete(null, toDelete)  
    });  
log.LogInformation("Delete-->Done");   
  
  
log.LogInformation("Add-->Start");  
List<FileDTO> toAdd = new List<FileDTO>();  
toAdd.Add(new FileDTO("<my-file>", "<url-to-file>"));  
var updateAdd = await qnaC.Knowledgebase.UpdateAsync(kbId, new UpdateKbOperationDTO  
    {  
        // Create JSON of changes ///  
        Add = new UpdateKbOperationDTOAdd(null, null, toAdd),  
        Update = null,  
        Delete = null  
    });  
log.LogInformation("Add-->Done");

SAI 1

Hi ramr-msft, thanks for reaching out the question. I have used create for creating a new knowledge base by uploading a file Multiturn-ContosoBenefits.pdf. But it returns me a error response as follows:

 "errorResponse": {  
        "error": {  
            "code": "BadArgument",  
            "message": "Failed to extract QnAs from the source",  
            "details": [  
                {  
                    "code": "ExtractionFailure",  
                    "message": "Unsupported / Invalid url(s). Failed to extract Q&A from the source",  
                    "target": "Multiturn-ContosoBenefits.pdf",  
                    "innerError": {  
                        "code": "CannotParse"  
                    }  
                }  
            ]  
        }  
    }

Please help me out with these.

1 answer

Your answer

Ramr-msft 17,826 Reputation points

2021-07-27T04:01:07.897+00:00

@SAI Thanks for the question. You can create your KB by using the QnAMaker APIs. Please follow the document for API's.
In particular, you can use the Update Knowledge Base operation, which will allow you to add/delete QnA Pairs and / or URLs to an existing knowledge base.
Ramr-msft 17,826 Reputation points

2021-07-27T04:03:38.24+00:00

Basically You can use UpdateKbOperationDTO Class listed here: class

but it allows to update KB with files using code instead of the interface.

Below is new code:

QnAMakerClient qnaC = new QnAMakerClient(new ApiKeyServiceClientCredentials(<subscription-key>)) { Endpoint = "https://<your-custom-domain>.cognitiveservices.azure.com"}; log.LogInformation("Delete-->Start"); List<string> toDelete = new List<string>(); toDelete.Add("<my-file>"); var updateDelete = await qnaC.Knowledgebase.UpdateAsync(kbId, new UpdateKbOperationDTO { // Create JSON of changes /// Add = null, Update = null, Delete = new UpdateKbOperationDTODelete(null, toDelete) }); log.LogInformation("Delete-->Done"); log.LogInformation("Add-->Start"); List<FileDTO> toAdd = new List<FileDTO>(); toAdd.Add(new FileDTO("<my-file>", "<url-to-file>")); var updateAdd = await qnaC.Knowledgebase.UpdateAsync(kbId, new UpdateKbOperationDTO { // Create JSON of changes /// Add = new UpdateKbOperationDTOAdd(null, null, toAdd), Update = null, Delete = null }); log.LogInformation("Add-->Done");
SAI 1 Reputation point

2021-07-27T04:59:40.847+00:00

Hi ramr-msft, thanks for reaching out the question. I have used create for creating a new knowledge base by uploading a file Multiturn-ContosoBenefits.pdf. But it returns me a error response as follows:

"errorResponse": { "error": { "code": "BadArgument", "message": "Failed to extract QnAs from the source", "details": [ { "code": "ExtractionFailure", "message": "Unsupported / Invalid url(s). Failed to extract Q&A from the source", "target": "Multiturn-ContosoBenefits.pdf", "innerError": { "code": "CannotParse" } } ] } }

Please help me out with these.

Answer 1

Ramr-msft 17,826

@SAI Here is the quick-start code to create a KB, We are able to create the KB and verify the same in QnA maker.

Python: https://github.com/Azure-Samples/cognitive-services-quickstart-code/tree/master/python/QnAMaker/rest

SAI 1

Hi ramr-msft, thanks for reaching out, but I have problem uploading file. I have tried the code for the repo. you shared. There is the same problem, same errorResponse:

"errorResponse": {
        "error": {
            "code": "BadArgument",
            "message": "Failed to extract QnAs from the source",
            "details": [
                {
                    "code": "ExtractionFailure",
                    "message": "Unsupported / Invalid url(s). Failed to extract Q&A from the source",
                    "target": "structured.docx",
                    "innerError": {
                        "code": "CannotParse"
                    }
                }
            ]
        }
    }

Also, now can you guide me how to get the q&a created ? I have tried downloading knowledge base but they are returning something else. Please help me with this too.

Ramr-msft 17,826 Reputation points

2021-07-30T03:47:11.17+00:00

@SAI Thanks for the details. Can you please share the request body that you are trying. Please follow the document to create multiple turns of a conversation in QnA Maker.

https://learn.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation#display-order-supported-in-api

For Multi-turn conversations:
SAI 1 Reputation point

2021-08-02T04:44:46.18+00:00

I am following this example, I have same request header as in the example create

Share via

How to upload a file to QnA Maker knowledge base using API ?

1 answer

Your answer