Knowledgebase - Update

Referens

Tjänst:: Azure AI Services

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

Asynkron åtgärd för att ändra en kunskapsbas.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Kunskapsbas-ID.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Name	Typ	Description
add	Add	En instans av CreateKbInputDTO för tilläggsåtgärd
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	Textsträng som ska användas som svar i valfri Q-A som inte har något extraherat svar från dokumentet men som har en hierarki. Krävs när fältet EnableHierarchicalExtraction är inställt på Sant.
delete	Delete	En instans av DeleteKbContentsDTO för borttagningsåtgärd
enableHierarchicalExtraction	boolean	Aktivera hierarkisk extrahering av Q-A från filer och URL:er. Värdet som anges när KB skapas används om det här fältet inte finns.
update	Update	En instans av UpdateKbContentsDTO för uppdateringsåtgärd

Svar

Name	Typ	Description
202 Accepted	Operation	Information om den asynkrona åtgärden. Sidhuvuden Location: string
Other Status Codes	ErrorResponse	Felsvar.

Name

Typ

Description

202 Accepted

Operation

Information om den asynkrona åtgärden.

Sidhuvuden

Location: string

Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

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
          ]
        }
      }
    ]
  }
}

Exempelsvar

Statuskod:: 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"
}

Definitioner

Name	Description
Add	En instans av CreateKbInputDTO för tilläggsåtgärd
Context	Kontext som är associerad med Qna som ska uppdateras.
Delete	En instans av DeleteKbContentsDTO för borttagningsåtgärd
Error	Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	En av en serverdefinierad uppsättning felkoder.
ErrorResponse	Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO för att lagra information om uppladdade filer.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Metadata	Lista över metadata som är associerade med svaret som ska uppdateras
MetadataDTO	Namn – värdepar med metadata.
Operation	Registrera för att spåra tidskrävande åtgärder.
OperationStateType	Åtgärdstillstånd.
PromptDTO	Fråga efter ett svar.
Qna	QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
QnADTO	Q-A-objekt.
Questions	Lista över frågor som är associerade med svaret.
Update	En instans av UpdateKbContentsDTO för uppdateringsåtgärd
UpdateKbOperationDTO	Innehåller en lista över frågor och svar som ska uppdateras
UpdateQnaDTO	PATCH-brödtextschema för uppdatera Qna-lista

Add

Objekt

En instans av CreateKbInputDTO för tilläggsåtgärd

Name	Typ	Description
files	FileDTO[]	Lista över filer som ska läggas till i kunskapsbasen.
qnaList	QnADTO[]	Lista över QNA som ska läggas till i indexet. Id:n genereras av tjänsten och bör utelämnas.
urls	string[]	Lista över URL:er som ska läggas till i kunskapsbasen.

Context

Objekt

Kontext som är associerad med Qna som ska uppdateras.

Name	Typ	Description
isContextOnly	boolean	Att markera om en fråga endast är relevant med en tidigare fråga eller inte. true – Inkludera inte denna QnA som sökresultat för frågor utan kontexten false – ignorerar kontexten och inkluderar denna QnA i sökresultatet
promptsToAdd	PromptDTO[]	Lista över uppmaningar som ska läggas till i qna.
promptsToDelete	integer[] (int32)	Lista över frågor som är associerade med qna som ska tas bort

Delete

Objekt

En instans av DeleteKbContentsDTO för borttagningsåtgärd

Name	Typ	Description
ids	integer[] (int32)	Lista över Qna-ID:t som ska tas bort
sources	string[]	Lista över källor som ska tas bort från kunskapsbasen.

Error

Objekt

Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	ErrorCodeType	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innerError	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCodeType

Uppräkning

En av en serverdefinierad uppsättning felkoder.

Värde	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objekt

Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
error	Error	Felobjektet.

FileDTO

Objekt

DTO för att lagra information om uppladdade filer.

Name	Typ	Description
fileName	string minLength: 1 maxLength: 200	Filnamn. Filtyper som stöds är ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	Offentlig URI för filen.
isUnstructured	boolean	Valfri flagga för att ange om den angivna filen är ostrukturerad.

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En mer specifik felkod än vad som angavs av det innehållande felet.
innerError	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

Metadata

Objekt

Lista över metadata som är associerade med svaret som ska uppdateras

Name	Typ	Description
add	MetadataDTO[]	Lista över metadata som är associerade med svar som ska läggas till
delete	MetadataDTO[]	Lista över metadata som är associerade med svar som ska tas bort

MetadataDTO

Objekt

Namn – värdepar med metadata.

Name	Typ	Description
name	string minLength: 1 maxLength: 100	Metadatanamn.
value	string minLength: 1 maxLength: 500	Metadatavärde.

Operation

Objekt

Registrera för att spåra tidskrävande åtgärder.

Name	Typ	Description
createdTimestamp	string	Tidsstämpel när åtgärden skapades.
errorResponse	ErrorResponse	Felinformation vid fel.
lastActionTimestamp	string	Tidsstämpel när det aktuella tillståndet angavs.
operationId	string	Åtgärds-ID.
operationState	OperationStateType	Åtgärdstillstånd.
resourceLocation	string	Relativ URI till målresursplatsen för slutförda resurser.
userId	string	Användar-ID

OperationStateType

Uppräkning

Åtgärdstillstånd.

Värde	Description
Failed
NotStarted
Running
Succeeded

PromptDTO

Objekt

Fråga efter ett svar.

Name	Typ	Description
displayOrder	integer (int32)	Index för prompten – används i ordning på prompterna
displayText	string maxLength: 200	Text som visas för att representera en fråga om uppföljning
qna	Qna	QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
qnaId	integer (int32)	Qna-ID som motsvarar prompten – om QnaId finns ignoreras QnADTO-objektet.

Qna

Objekt

QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt

Name	Typ	Description
answer	string minLength: 1 maxLength: 25000	Svarstext
context	Context	Kontext för en QnA
id	integer (int32)	Unikt ID för Q-A.
lastUpdatedTimestamp	string maxLength: 300	Tidsstämpel när QnA senast uppdaterades.
metadata	MetadataDTO[]	Lista över metadata som är associerade med svaret.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string maxLength: 300	Källa som Q-A indexerades från. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objekt

Q-A-objekt.

Name	Typ	Description
answer	string minLength: 1 maxLength: 25000	Svarstext
context	Context	Kontext för en QnA
id	integer (int32)	Unikt ID för Q-A.
lastUpdatedTimestamp	string maxLength: 300	Tidsstämpel när QnA senast uppdaterades.
metadata	MetadataDTO[]	Lista över metadata som är associerade med svaret.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string maxLength: 300	Källa som Q-A indexerades från. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Objekt

Lista över frågor som är associerade med svaret.

Name	Typ	Description
add	string[]	Lista över frågor som ska läggas till
delete	string[]	Lista över frågor som ska tas bort.

Update

Objekt

En instans av UpdateKbContentsDTO för uppdateringsåtgärd

Name	Typ	Description
defaultAnswer	string minLength: 1 maxLength: 300	Standardsvaret skickas till användaren om ingen bra matchning hittas i KB.
name	string	Eget namn på kunskapsbasen.
qnaList	UpdateQnaDTO[]	Lista över Q-A (UpdateQnaDTO) som ska läggas till i kunskapsbasen.
urls	string[]	Lista över befintliga URL:er som ska uppdateras. Innehållet extraheras igen och indexeras igen.

UpdateKbOperationDTO

Objekt

Innehåller en lista över frågor och svar som ska uppdateras

Name	Typ	Description
add	Add	En instans av CreateKbInputDTO för tilläggsåtgärd
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	Textsträng som ska användas som svar i valfri Q-A som inte har något extraherat svar från dokumentet men som har en hierarki. Krävs när fältet EnableHierarchicalExtraction är inställt på Sant.
delete	Delete	En instans av DeleteKbContentsDTO för borttagningsåtgärd
enableHierarchicalExtraction	boolean	Aktivera hierarkisk extrahering av Q-A från filer och URL:er. Värdet som anges när KB skapas används om det här fältet inte finns.
update	Update	En instans av UpdateKbContentsDTO för uppdateringsåtgärd

UpdateQnaDTO

Objekt

PATCH-brödtextschema för uppdatera Qna-lista

Name	Typ	Description
answer	string	Svarstext
context	Context	Kontext som är associerad med Qna som ska uppdateras.
id	integer (int32) minimum: 0 maximum: 2147483647	Unikt ID för Q-A
metadata	Metadata	Lista över metadata som är associerade med svaret som ska uppdateras
questions	Questions	Lista över frågor som är associerade med svaret.
source	string maxLength: 300	Källa som Q-A indexerades från. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Dela via

Knowledgebase - Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Successful query

Exempelbegäran

Exempelsvar

Definitioner

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Ytterligare resurser