Knowledgebase - Update

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: v5.0-preview.2

Operacja asynchroniczna w celu zmodyfikowania bazy wiedzy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Identyfikator bazy wiedzy.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Nazwa	Typ	Opis
add	Add	Wystąpienie polecenia CreateKbInputDTO dla operacji dodawania
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	Ciąg tekstowy, który ma być używany jako odpowiedź w dowolnym Q-A, który nie ma wyodrębnionej odpowiedzi z dokumentu, ale ma hierarchię. Wymagane, gdy pole EnableHierarchicalExtraction ma wartość True.
delete	Delete	Wystąpienie obiektu DeleteKbContentsDTO dla operacji usuwania
enableHierarchicalExtraction	boolean	Włącz hierarchiczne wyodrębnianie Q-A z plików i adresów URL. Wartość ustawiona podczas tworzenia bazy wiedzy zostanie użyta, jeśli to pole nie jest obecne.
update	Update	Wystąpienie elementu UpdateKbContentsDTO dla operacji aktualizacji

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	Operation	Szczegóły operacji asynchronicznej. Nagłówki Location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Nazwa

Typ

Opis

202 Accepted

Operation

Szczegóły operacji asynchronicznej.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful query

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Add	Wystąpienie polecenia CreateKbInputDTO dla operacji dodawania
Context	Kontekst skojarzony z funkcją Qna do zaktualizowania.
Delete	Wystąpienie obiektu DeleteKbContentsDTO dla operacji usuwania
Error	Obiekt błędu. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
ErrorResponse	Odpowiedź na błąd. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO do przechowywania szczegółów przekazanych plików.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Metadata	Lista metadanych skojarzonych z odpowiedzią, która ma zostać zaktualizowana
MetadataDTO	Name — para wartości metadanych.
Operation	Rejestruj, aby śledzić długotrwałą operację.
OperationStateType	Stan operacji.
PromptDTO	Monituj o odpowiedź.
Qna	QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO
QnADTO	Obiekt Q-A.
Questions	Lista pytań skojarzonych z odpowiedzią.
Update	Wystąpienie elementu UpdateKbContentsDTO dla operacji aktualizacji
UpdateKbOperationDTO	Zawiera listę pytań i odpowiedzi do zaktualizowania
UpdateQnaDTO	Schemat treści PATCH dla aktualizacji listy Qna

Add

Objekt

Wystąpienie polecenia CreateKbInputDTO dla operacji dodawania

Nazwa	Typ	Opis
files	FileDTO[]	Lista plików do dodania do bazy wiedzy.
qnaList	QnADTO[]	Lista pytań i odpowiedzi do dodania do indeksu. Identyfikatory są generowane przez usługę i powinny zostać pominięte.
urls	string[]	Lista adresów URL do dodania do bazy wiedzy.

Context

Objekt

Kontekst skojarzony z funkcją Qna do zaktualizowania.

Nazwa	Typ	Opis
isContextOnly	boolean	Aby zaznaczyć, czy monit jest odpowiedni tylko z poprzednim pytaniem, czy nie. true — nie dołączaj tej usługi pytań i odpowiedzi jako wyników wyszukiwania dla zapytań bez wartości false kontekstu — ignoruje kontekst i uwzględnia tę funkcję pytań i odpowiedzi w wynikach wyszukiwania
promptsToAdd	PromptDTO[]	Lista monitów do dodania do qna.
promptsToDelete	integer[] (int32)	Lista monitów skojarzonych z funkcją qna do usunięcia

Delete

Objekt

Wystąpienie obiektu DeleteKbContentsDTO dla operacji usuwania

Nazwa	Typ	Opis
ids	integer[] (int32)	Lista identyfikatorów Qna do usunięcia
sources	string[]	Lista źródeł do usunięcia z bazy wiedzy.

Error

Objekt

Obiekt błędu. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	ErrorCodeType	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innerError	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCodeType

Wyliczanie

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

Wartość	Opis
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objekt

Odpowiedź na błąd. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

FileDTO

Objekt

DTO do przechowywania szczegółów przekazanych plików.

Nazwa	Typ	Opis
fileName	string minLength: 1 maxLength: 200	Nazwa pliku. Obsługiwane typy plików to ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	Publiczny identyfikator URI pliku.
isUnstructured	boolean	Opcjonalna flaga określająca, czy dany plik jest nieustrukturyzowany.

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innerError	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

Metadata

Objekt

Lista metadanych skojarzonych z odpowiedzią, która ma zostać zaktualizowana

Nazwa	Typ	Opis
add	MetadataDTO[]	Lista metadanych skojarzonych z odpowiedzią do dodania
delete	MetadataDTO[]	Lista metadanych skojarzonych z odpowiedzią na usunięcie

MetadataDTO

Objekt

Name — para wartości metadanych.

Nazwa	Typ	Opis
name	string minLength: 1 maxLength: 100	Nazwa metadanych.
value	string minLength: 1 maxLength: 500	Wartość metadanych.

Operation

Objekt

Rejestruj, aby śledzić długotrwałą operację.

Nazwa	Typ	Opis
createdTimestamp	string	Sygnatura czasowa utworzenia operacji.
errorResponse	ErrorResponse	Szczegóły błędu w przypadku awarii.
lastActionTimestamp	string	Sygnatura czasowa po wprowadzeniu bieżącego stanu.
operationId	string	Identyfikator operacji.
operationState	OperationStateType	Stan operacji.
resourceLocation	string	Względny identyfikator URI do lokalizacji zasobu docelowego dla ukończonych zasobów.
userId	string	Identyfikator użytkownika

OperationStateType

Wyliczanie

Stan operacji.

Wartość	Opis
Failed
NotStarted
Running
Succeeded

PromptDTO

Objekt

Monituj o odpowiedź.

Nazwa	Typ	Opis
displayOrder	integer (int32)	Indeks monitu — używany w kolejności monitów
displayText	string maxLength: 200	Tekst wyświetlany w celu reprezentowania monitu o pytanie
qna	Qna	QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO
qnaId	integer (int32)	Identyfikator Qna odpowiadający monitowi — jeśli jest obecny identyfikator QnaId, obiekt QnADTO jest ignorowany.

Qna

Objekt

QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO

Nazwa	Typ	Opis
answer	string minLength: 1 maxLength: 25000	Tekst odpowiedzi
context	Context	Kontekst pytań i pytań
id	integer (int32)	Unikatowy identyfikator Q-A.
lastUpdatedTimestamp	string maxLength: 300	Sygnatura czasowa ostatniej aktualizacji usługi QnA.
metadata	MetadataDTO[]	Lista metadanych skojarzonych z odpowiedzią.
questions	string[]	Lista pytań skojarzonych z odpowiedzią.
source	string maxLength: 300	Źródło, z którego indeksowano Q-A. Np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objekt

Obiekt Q-A.

Nazwa	Typ	Opis
answer	string minLength: 1 maxLength: 25000	Tekst odpowiedzi
context	Context	Kontekst pytań i pytań
id	integer (int32)	Unikatowy identyfikator Q-A.
lastUpdatedTimestamp	string maxLength: 300	Sygnatura czasowa ostatniej aktualizacji usługi QnA.
metadata	MetadataDTO[]	Lista metadanych skojarzonych z odpowiedzią.
questions	string[]	Lista pytań skojarzonych z odpowiedzią.
source	string maxLength: 300	Źródło, z którego indeksowano Q-A. Np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Objekt

Lista pytań skojarzonych z odpowiedzią.

Nazwa	Typ	Opis
add	string[]	Lista pytań do dodania
delete	string[]	Lista pytań do usunięcia.

Update

Objekt

Wystąpienie elementu UpdateKbContentsDTO dla operacji aktualizacji

Nazwa	Typ	Opis
defaultAnswer	string minLength: 1 maxLength: 300	Domyślna odpowiedź wysłana do użytkownika, jeśli nie znaleziono dobrego dopasowania w bazie wiedzy.
name	string	Przyjazna nazwa bazy wiedzy.
qnaList	UpdateQnaDTO[]	Lista pytań i odpowiedzi (UpdateQnaDTO) do dodania do bazy wiedzy.
urls	string[]	Lista istniejących adresów URL do odświeżenia. Zawartość zostanie ponownie wyodrębniona i ponownie zindeksowana.

UpdateKbOperationDTO

Objekt

Zawiera listę pytań i odpowiedzi do zaktualizowania

Nazwa	Typ	Opis
add	Add	Wystąpienie polecenia CreateKbInputDTO dla operacji dodawania
defaultAnswerUsedForExtraction	string minLength: 1 maxLength: 300	Ciąg tekstowy, który ma być używany jako odpowiedź w dowolnym Q-A, który nie ma wyodrębnionej odpowiedzi z dokumentu, ale ma hierarchię. Wymagane, gdy pole EnableHierarchicalExtraction ma wartość True.
delete	Delete	Wystąpienie obiektu DeleteKbContentsDTO dla operacji usuwania
enableHierarchicalExtraction	boolean	Włącz hierarchiczne wyodrębnianie Q-A z plików i adresów URL. Wartość ustawiona podczas tworzenia bazy wiedzy zostanie użyta, jeśli to pole nie jest obecne.
update	Update	Wystąpienie elementu UpdateKbContentsDTO dla operacji aktualizacji

UpdateQnaDTO

Objekt

Schemat treści PATCH dla aktualizacji listy Qna

Nazwa	Typ	Opis
answer	string	Tekst odpowiedzi
context	Context	Kontekst skojarzony z funkcją Qna do zaktualizowania.
id	integer (int32) minimum: 0 maximum: 2147483647	Unikatowy identyfikator Q-A
metadata	Metadata	Lista metadanych skojarzonych z odpowiedzią, która ma zostać zaktualizowana
questions	Questions	Lista pytań skojarzonych z odpowiedzią.
source	string maxLength: 300	Źródło, z którego indeksowano Q-A. Np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Udostępnij za pośrednictwem

Knowledgebase - Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Successful query

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Dodatkowe zasoby