Knowledgebase - Update

Referentie

Service:: Azure AI Services

API-versie:: v5.0-preview.2

Asynchrone bewerking om een knowledgebase te wijzigen.

PATCH {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Knowledgebase-id.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Aanvraagbody

Name	Type	Description
add	Add	Een exemplaar van CreateKbInputDTO voor het toevoegen van bewerkingen
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	Teksttekenreeks die moet worden gebruikt als antwoord in een Q-A die geen geëxtraheerd antwoord uit het document heeft, maar een hiërarchie heeft. Vereist wanneer het veld EnableHierarchicalExtraction is ingesteld op True.
delete	Delete	Een exemplaar van DeleteKbContentsDTO voor verwijderingsbewerking
enableHierarchicalExtraction	boolean	Schakel hiërarchische extractie van Q-A in vanuit bestanden en URL's. De waarde die is ingesteld tijdens het maken van kb, wordt gebruikt als dit veld niet aanwezig is.
update	Update	Een exemplaar van UpdateKbContentsDTO voor updatebewerking

Antwoorden

Name	Type	Description
202 Accepted	Operation	Details van de asynchrone bewerking. Kopteksten Location: string
Other Status Codes	ErrorResponse	Foutreactie.

Name

Type

Description

202 Accepted

Operation

Details van de asynchrone bewerking.

Kopteksten

Location: string

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

PATCH {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


{
  "add": {
    "qnaList": [
      {
        "id": 0,
        "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
        "source": "Custom Editorial",
        "questions": [
          "How can I change the default message from QnA Maker?"
        ],
        "metadata": []
      }
    ],
    "urls": [
      "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
    ],
    "files": [
      {
        "fileName": "SurfaceManual.pdf",
        "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
      }
    ]
  },
  "delete": {
    "ids": [
      13,
      35
    ]
  },
  "update": {
    "name": "QnA Maker FAQ Prompts Bot",
    "qnaList": [
      {
        "id": 2,
        "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
        "source": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "add": [],
          "delete": []
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Add Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I add prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Delete Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I delete delete prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Update Knowledgebase",
              "displayOrder": 0,
              "qna": null,
              "qnaId": 3
            }
          ],
          "promptsToDelete": [
            3
          ]
        }
      },
      {
        "id": 3,
        "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
        "source": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "delete": [
            {
              "name": "category",
              "value": "api"
            }
          ],
          "add": [
            {
              "name": "category",
              "value": "programmatic"
            }
          ]
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Regenerate Endpoint keys",
              "displayOrder": 1,
              "qna": null,
              "qnaId": 4
            }
          ],
          "promptsToDelete": [
            4
          ]
        }
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

Definities

Name	Description
Add	Een exemplaar van CreateKbInputDTO voor het toevoegen van bewerkingen
Context	Context die is gekoppeld aan Qna die moet worden bijgewerkt.
Delete	Een exemplaar van DeleteKbContentsDTO voor verwijderingsbewerking
Error	Het foutobject. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Een van een door de server gedefinieerde set foutcodes.
ErrorResponse	Foutreactie. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO voor het opslaan van details van geüploade bestanden.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Metadata	Lijst met metagegevens die zijn gekoppeld aan het antwoord dat moet worden bijgewerkt
MetadataDTO	Naam: waardepaar met metagegevens.
Operation	Record voor het bijhouden van langdurige bewerkingen.
OperationStateType	Bewerkingsstatus.
PromptDTO	Vraag om een antwoord.
Qna	QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
QnADTO	Q-A-object.
Questions	Lijst met vragen die aan het antwoord zijn gekoppeld.
Update	Een exemplaar van UpdateKbContentsDTO voor updatebewerking
UpdateKbOperationDTO	Bevat een lijst met QnA's die moeten worden bijgewerkt
UpdateQnaDTO	PATCH-hoofdtekstschema voor Qna-lijst bijwerken

Add

Object

Een exemplaar van CreateKbInputDTO voor het toevoegen van bewerkingen

Name	Type	Description
files	FileDTO[]	Lijst met bestanden die moeten worden toegevoegd aan knowledgebase.
qnaList	QnADTO[]	Lijst met QNA die moet worden toegevoegd aan de index. Id's worden gegenereerd door de service en moeten worden weggelaten.
urls	string[]	Lijst met URL's die moeten worden toegevoegd aan knowledgebase.

Context

Object

Context die is gekoppeld aan Qna die moet worden bijgewerkt.

Name	Type	Description
isContextOnly	boolean	Als u wilt markeren of een prompt alleen relevant is voor een vorige vraag of niet. true - Neem deze QnA niet op als zoekresultaat voor query's zonder context false - negeert context en bevat deze QnA in het zoekresultaat
promptsToAdd	PromptDTO[]	Lijst met prompts die moeten worden toegevoegd aan de qna.
promptsToDelete	integer[] (int32)	Lijst met prompts die zijn gekoppeld aan qna die moeten worden verwijderd

Delete

Object

Een exemplaar van DeleteKbContentsDTO voor verwijderingsbewerking

Name	Type	Description
ids	integer[] (int32)	Lijst met Qna-id's die moeten worden verwijderd
sources	string[]	Lijst met bronnen die moeten worden verwijderd uit knowledgebase.

Error

Object

Het foutobject. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	ErrorCodeType	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innerError	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCodeType

Inventarisatie

Een van een door de server gedefinieerde set foutcodes.

Waarde	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

Foutreactie. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
error	Error	Het foutobject.

FileDTO

Object

DTO voor het opslaan van details van geüploade bestanden.

Name	Type	Description
fileName	string minLength: 1 maxLength: 200	Bestandsnaam. Ondersteunde bestandstypen zijn .tsv,.pdf", ".txt", ".docx", ".xlsx".
fileUri	string	Openbare URI van het bestand.
isUnstructured	boolean	Optionele vlag om op te geven of het opgegeven bestand ongestructureerd is.

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
innerError	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.

Metadata

Object

Lijst met metagegevens die zijn gekoppeld aan het antwoord dat moet worden bijgewerkt

Name	Type	Description
add	MetadataDTO[]	Lijst met metagegevens die zijn gekoppeld aan antwoord dat moet worden toegevoegd
delete	MetadataDTO[]	Lijst met metagegevens die zijn gekoppeld aan het antwoord dat moet worden verwijderd

MetadataDTO

Object

Naam: waardepaar met metagegevens.

Name	Type	Description
name	string minLength: 1 maxLength: 100	Naam van metagegevens.
value	string minLength: 1 maxLength: 500	Metagegevenswaarde.

Operation

Object

Record voor het bijhouden van langdurige bewerkingen.

Name	Type	Description
createdTimestamp	string	Tijdstempel toen de bewerking werd gemaakt.
errorResponse	ErrorResponse	Foutdetails in geval van fouten.
lastActionTimestamp	string	Tijdstempel toen de huidige status werd ingevoerd.
operationId	string	Bewerkings-id.
operationState	OperationStateType	Bewerkingsstatus.
resourceLocation	string	Relatieve URI naar de doelresourcelocatie voor voltooide resources.
userId	string	Gebruikers-ID

OperationStateType

Inventarisatie

Bewerkingsstatus.

Waarde	Description
Failed
NotStarted
Running
Succeeded

PromptDTO

Object

Vraag om een antwoord.

Name	Type	Description
displayOrder	integer (int32)	Index van de prompt - gebruikt in volgorde van de prompts
displayText	string maxLength: 200	Tekst die wordt weergegeven om een vervolgvraagprompt weer te geven
qna	Qna	QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
qnaId	integer (int32)	Qna-id die overeenkomt met de prompt: als QnaId aanwezig is, wordt het QnADTO-object genegeerd.

Qna

Object

QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object

Name	Type	Description
answer	string minLength: 1 maxLength: 25000	Antwoordtekst
context	Context	Context van een QnA
id	integer (int32)	Unieke id voor de Q-A.
lastUpdatedTimestamp	string maxLength: 300	Tijdstempel waarop de QnA voor het laatst is bijgewerkt.
metadata	MetadataDTO[]	Lijst met metagegevens die aan het antwoord zijn gekoppeld.
questions	string[]	Lijst met vragen die aan het antwoord zijn gekoppeld.
source	string maxLength: 300	Bron waaruit Q-A is geïndexeerd. bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Object

Q-A-object.

Name	Type	Description
answer	string minLength: 1 maxLength: 25000	Antwoordtekst
context	Context	Context van een QnA
id	integer (int32)	Unieke id voor de Q-A.
lastUpdatedTimestamp	string maxLength: 300	Tijdstempel waarop de QnA voor het laatst is bijgewerkt.
metadata	MetadataDTO[]	Lijst met metagegevens die aan het antwoord zijn gekoppeld.
questions	string[]	Lijst met vragen die aan het antwoord zijn gekoppeld.
source	string maxLength: 300	Bron waaruit Q-A is geïndexeerd. bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Object

Lijst met vragen die aan het antwoord zijn gekoppeld.

Name	Type	Description
add	string[]	Lijst met vragen die moeten worden toegevoegd
delete	string[]	Lijst met vragen die moeten worden verwijderd.

Update

Object

Een exemplaar van UpdateKbContentsDTO voor updatebewerking

Name	Type	Description
defaultAnswer	string minLength: 1 maxLength: 300	Standaardantwoord dat naar de gebruiker wordt verzonden als er geen goede overeenkomst wordt gevonden in de KB.
name	string	Beschrijvende naam voor de knowledgebase.
qnaList	UpdateQnaDTO[]	Lijst met Q-A (UpdateQnaDTO) die moet worden toegevoegd aan de knowledgebase.
urls	string[]	Lijst met bestaande URL's die moeten worden vernieuwd. De inhoud wordt opnieuw geëxtraheerd en opnieuw geïndexeerd.

UpdateKbOperationDTO

Object

Bevat een lijst met QnA's die moeten worden bijgewerkt

Name	Type	Description
add	Add	Een exemplaar van CreateKbInputDTO voor het toevoegen van bewerkingen
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	Teksttekenreeks die moet worden gebruikt als antwoord in een Q-A die geen geëxtraheerd antwoord uit het document heeft, maar een hiërarchie heeft. Vereist wanneer het veld EnableHierarchicalExtraction is ingesteld op True.
delete	Delete	Een exemplaar van DeleteKbContentsDTO voor verwijderingsbewerking
enableHierarchicalExtraction	boolean	Schakel hiërarchische extractie van Q-A in vanuit bestanden en URL's. De waarde die is ingesteld tijdens het maken van kb, wordt gebruikt als dit veld niet aanwezig is.
update	Update	Een exemplaar van UpdateKbContentsDTO voor updatebewerking

UpdateQnaDTO

Object

PATCH-hoofdtekstschema voor Qna-lijst bijwerken

Name	Type	Description
answer	string	Antwoordtekst
context	Context	Context die is gekoppeld aan Qna die moet worden bijgewerkt.
id	integer (int32) minimum: 0 maximum: 2147483647	Unieke id voor de Q-A
metadata	Metadata	Lijst met metagegevens die zijn gekoppeld aan het antwoord dat moet worden bijgewerkt
questions	Questions	Lijst met vragen die aan het antwoord zijn gekoppeld.
source	string maxLength: 300	Bron waaruit Q-A is geïndexeerd. bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Delen via

Knowledgebase - Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

Successful query

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Aanvullende resources