diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/QnAMaker.json new file mode 100644 index 000000000000..0d9c4c84d099 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/QnAMaker.json @@ -0,0 +1,1907 @@ +{ + "swagger": "2.0", + "info": { + "version": "v5.0-preview.1", + "title": "QnAMaker Client", + "description": "An API for QnAMaker Service" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/qnamaker/v5.0-preview.1", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "paths": { + "/endpointSettings": { + "get": { + "summary": "Gets endpoint settings for an endpoint.", + "operationId": "EndpointSettings_GetSettings", + "parameters": [], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Response with endpoint settings info in it.", + "schema": { + "$ref": "#/definitions/EndpointSettingsDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetEpSettings.json" + } + } + }, + "patch": { + "tags": [ + "EndpointKeys" + ], + "summary": "Updates endpoint settings for an endpoint.", + "operationId": "EndpointSettings_UpdateSettings", + "parameters": [ + { + "$ref": "#/parameters/EndpointSettingsPayload" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No Content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSetEpSettings.json" + } + } + } + }, + "/endpointkeys": { + "get": { + "summary": "Gets endpoint keys for an endpoint", + "operationId": "EndpointKeys_GetKeys", + "parameters": [], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Response with endpoint info in it.", + "schema": { + "$ref": "#/definitions/EndpointKeysDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetEpKeys.json" + } + } + } + }, + "/endpointkeys/{keyType}": { + "patch": { + "tags": [ + "EndpointKeys" + ], + "summary": "Re-generates an endpoint key.", + "operationId": "EndpointKeys_RefreshKeys", + "parameters": [ + { + "$ref": "#/parameters/KeyType" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Details of the endpoint keys generated.", + "schema": { + "$ref": "#/definitions/EndpointKeysDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSetEpKeys.json" + } + } + } + }, + "/alterations": { + "get": { + "tags": [ + "Alterations" + ], + "summary": "Download alterations from runtime.", + "operationId": "Alterations_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Alterations data.", + "schema": { + "$ref": "#/definitions/WordAlterationsDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetAlts.json" + } + } + }, + "put": { + "tags": [ + "Alterations" + ], + "summary": "Replace alterations data.", + "operationId": "Alterations_Replace", + "parameters": [ + { + "$ref": "#/parameters/WordAlterations" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No Content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSetAlts.json" + } + } + } + }, + "/alterations/{kbId}": { + "get": { + "tags": [ + "Alterations" + ], + "summary": "Download alterations per Knowledgebase (QnAMaker Managed).", + "operationId": "Alterations_GetAlterationsForKb", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Alterations data.", + "schema": { + "$ref": "#/definitions/WordAlterationsDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetAltsForKb.json" + } + } + }, + "put": { + "tags": [ + "Alterations" + ], + "summary": "Replace alterations data per Knowledgebase (QnAMaker Managed).", + "operationId": "Alterations_ReplaceAlterationsForKb", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/WordAlterations" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No Content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSetAltsForKb.json" + } + } + } + }, + "/knowledgebases": { + "get": { + "tags": [ + "Knowledgebases" + ], + "summary": "Gets all knowledgebases for a user.", + "operationId": "Knowledgebase_ListAll", + "parameters": [], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Collection of knowledgebases.", + "schema": { + "$ref": "#/definitions/KnowledgebasesDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulKbsResponse.json" + } + } + } + }, + "/operations/{operationId}": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Gets details of a specific long running operation.", + "operationId": "Operations_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/OperationId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Details of the long running operation.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "x-nullable": true, + "headers": { + "RetryAfter": { + "type": "integer", + "description": "Indicates how long the client should wait before sending a follow up request. The header will be present only if the operation is running or has not started yet." + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetOps.json" + } + } + } + }, + "/knowledgebases/{kbId}": { + "get": { + "tags": [ + "Knowledgebases" + ], + "summary": "Gets details of a specific knowledgebase.", + "operationId": "Knowledgebase_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Details of the knowledgebase.", + "schema": { + "$ref": "#/definitions/KnowledgebaseDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetKb.json" + } + } + }, + "delete": { + "tags": [ + "Knowledgebases" + ], + "summary": "Deletes the knowledgebase and all its data.", + "operationId": "Knowledgebase_Delete", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulDelKb.json" + } + } + }, + "post": { + "tags": [ + "Knowledgebases" + ], + "summary": "Publishes all changes in test index of a knowledgebase to its prod index.", + "operationId": "Knowledgebase_Publish", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulPubKb.json" + } + } + }, + "put": { + "tags": [ + "Knowledgebases" + ], + "summary": "Replace knowledgebase contents.", + "operationId": "Knowledgebase_Replace", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/ReplaceKb" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulRepKb.json" + } + } + }, + "patch": { + "tags": [ + "Knowledgebases" + ], + "summary": "Asynchronous operation to modify a knowledgebase.", + "operationId": "Knowledgebase_Update", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/UpdateKb" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "Details of the asynchronous operation.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "x-nullable": true, + "headers": { + "Location": { + "type": "string", + "description": "Relative URI to the target location of the asynchronous operation. Client should poll this resource to get status of the operation." + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulUpdKb.json" + } + } + } + }, + "/knowledgebases/create": { + "post": { + "tags": [ + "Knowledgebases" + ], + "summary": "Asynchronous operation to create a new knowledgebase.", + "operationId": "Knowledgebase_Create", + "parameters": [ + { + "$ref": "#/parameters/CreateKbPayload" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "Details of the asynchronous operation.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulCreateKb.json" + } + } + } + }, + "/knowledgebases/{kbId}/{environment}/qna": { + "get": { + "tags": [ + "Knowledgebases" + ], + "summary": "Download the knowledgebase.", + "operationId": "Knowledgebase_Download", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/Environment" + }, + { + "name": "source", + "in": "query", + "description": "The source property filter to apply.", + "required": false, + "type": "string" + }, + { + "name": "changedSince", + "in": "query", + "description": "The last changed status property filter to apply.", + "required": false, + "type": "string" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Collection of all Q-A in the knowledgebase.", + "schema": { + "$ref": "#/definitions/QnADocumentsDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulDownloadKb.json" + } + } + } + }, + "/knowledgebases/{kbId}/generateAnswer": { + "post": { + "tags": [ + "Knowledgebases" + ], + "summary": "GenerateAnswer call to query knowledgebase (QnA Maker Managed).", + "operationId": "Knowledgebase_GenerateAnswer", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/GenerateAnswerPayload" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "GenerateAnswer call response.", + "schema": { + "$ref": "#/definitions/QnASearchResultList" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGenAns.json" + } + } + } + }, + "/knowledgebases/{kbId}/train": { + "post": { + "tags": [ + "Knowledgebases" + ], + "summary": "Train call to add suggestions to knowledgebase (QnAMaker Managed).", + "operationId": "Knowledgebase_Train", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/TrainPayload" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No Content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulTrain.json" + } + } + } + } + }, + "definitions": { + "UpdateKbOperationDTO": { + "type": "object", + "description": "Contains list of QnAs to be updated", + "additionalProperties": false, + "properties": { + "add": { + "description": "An instance of CreateKbInputDTO for add operation", + "allOf": [ + { + "$ref": "#/definitions/CreateKbInputDTO" + } + ] + }, + "delete": { + "description": "An instance of DeleteKbContentsDTO for delete Operation", + "allOf": [ + { + "$ref": "#/definitions/DeleteKbContentsDTO" + } + ] + }, + "update": { + "description": "An instance of UpdateKbContentsDTO for Update Operation", + "allOf": [ + { + "$ref": "#/definitions/UpdateKbContentsDTO" + } + ] + }, + "enableHierarchicalExtraction": { + "type": "boolean", + "description": "Enable hierarchical extraction of Q-A from files and urls. The value set during KB creation will be used if this field is not present." + }, + "defaultAnswerUsedForExtraction": { + "type": "string", + "description": "Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.", + "maxLength": 300, + "minLength": 1 + } + } + }, + "UpdateKbContentsDTO": { + "type": "object", + "description": "PATCH body schema for Update operation in Update Kb", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "Friendly name for the knowledgebase." + }, + "qnaList": { + "type": "array", + "description": "List of Q-A (UpdateQnaDTO) to be added to the knowledgebase.", + "items": { + "$ref": "#/definitions/UpdateQnaDTO" + } + }, + "urls": { + "type": "array", + "description": "List of existing URLs to be refreshed. The content will be extracted again and re-indexed.", + "maxLength": 10, + "items": { + "type": "string" + } + } + } + }, + "UpdateQnaDTO": { + "type": "object", + "description": "PATCH Body schema for Update Qna List", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer", + "description": "Unique id for the Q-A", + "format": "int32", + "maximum": 2147483647, + "minimum": 0 + }, + "answer": { + "type": "string", + "description": "Answer text" + }, + "source": { + "type": "string", + "description": "Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs", + "maxLength": 300 + }, + "questions": { + "description": "List of questions associated with the answer.", + "allOf": [ + { + "$ref": "#/definitions/UpdateQuestionsDTO" + } + ] + }, + "metadata": { + "description": "List of metadata associated with the answer to be updated", + "allOf": [ + { + "$ref": "#/definitions/UpdateMetadataDTO" + } + ] + }, + "context": { + "description": "Context associated with Qna to be updated.", + "allOf": [ + { + "$ref": "#/definitions/UpdateContextDTO" + } + ] + } + } + }, + "UpdateQuestionsDTO": { + "type": "object", + "description": "PATCH Body schema for Update Kb which contains list of questions to be added and deleted", + "additionalProperties": false, + "properties": { + "add": { + "type": "array", + "description": "List of questions to be added", + "maxLength": 100, + "items": { + "type": "string" + } + }, + "delete": { + "type": "array", + "description": "List of questions to be deleted.", + "maxLength": 100, + "items": { + "type": "string" + } + } + } + }, + "UpdateMetadataDTO": { + "type": "object", + "description": "PATCH Body schema to represent list of Metadata to be updated", + "additionalProperties": false, + "properties": { + "delete": { + "type": "array", + "description": "List of Metadata associated with answer to be deleted", + "maxLength": 100, + "items": { + "$ref": "#/definitions/MetadataDTO" + } + }, + "add": { + "type": "array", + "description": "List of metadata associated with answer to be added", + "maxLength": 100, + "items": { + "$ref": "#/definitions/MetadataDTO" + } + } + } + }, + "UpdateContextDTO": { + "type": "object", + "description": "Update Body schema to represent context to be updated", + "properties": { + "promptsToDelete": { + "type": "array", + "description": "List of prompts associated with qna to be deleted", + "items": { + "type": "integer", + "format": "int32" + } + }, + "promptsToAdd": { + "type": "array", + "description": "List of prompts to be added to the qna.", + "items": { + "$ref": "#/definitions/PromptDTO" + } + }, + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not.\ntrue - Do not include this QnA as search result for queries without context\nfalse - ignores context and includes this QnA in search result" + } + } + }, + "DeleteKbContentsDTO": { + "type": "object", + "description": "PATCH body schema of Delete Operation in UpdateKb", + "additionalProperties": false, + "properties": { + "ids": { + "type": "array", + "description": "List of Qna Ids to be deleted", + "items": { + "type": "integer", + "format": "int32" + } + }, + "sources": { + "type": "array", + "description": "List of sources to be deleted from knowledgebase.", + "maxLength": 300, + "minLength": 1, + "items": { + "type": "string" + } + } + } + }, + "CreateKbInputDTO": { + "type": "object", + "description": "Input to create KB.", + "additionalProperties": false, + "properties": { + "qnaList": { + "type": "array", + "description": "List of QNA to be added to the index. Ids are generated by the service and should be omitted.", + "items": { + "$ref": "#/definitions/QnADTO" + } + }, + "urls": { + "type": "array", + "description": "List of URLs to be added to knowledgebase.", + "maxLength": 10, + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "description": "List of files to be added to knowledgebase.", + "maxLength": 10, + "items": { + "$ref": "#/definitions/FileDTO" + } + } + } + }, + "QnADocumentsDTO": { + "type": "object", + "description": "List of QnADTO", + "additionalProperties": false, + "properties": { + "qnaDocuments": { + "type": "array", + "description": "List of answers.", + "items": { + "$ref": "#/definitions/QnADTO" + } + } + } + }, + "CreateKbDTO": { + "type": "object", + "description": "Post body schema for CreateKb operation.", + "additionalProperties": false, + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Friendly name for the knowledgebase.", + "maxLength": 100, + "minLength": 1 + }, + "qnaList": { + "type": "array", + "description": "List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.", + "maxLength": 1000, + "items": { + "$ref": "#/definitions/QnADTO" + } + }, + "urls": { + "type": "array", + "description": "List of URLs to be used for extracting Q-A.", + "maxLength": 10, + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "description": "List of files from which to Extract Q-A.", + "maxLength": 10, + "items": { + "$ref": "#/definitions/FileDTO" + } + }, + "enableHierarchicalExtraction": { + "type": "boolean", + "description": "Enable hierarchical extraction of Q-A from files and urls. Value to be considered False if this field is not present." + }, + "defaultAnswerUsedForExtraction": { + "type": "string", + "description": "Text string to be used as the answer in any Q-A which has no extracted answer from the document but has a hierarchy. Required when EnableHierarchicalExtraction field is set to True.", + "maxLength": 300, + "minLength": 1 + }, + "language": { + "type": "string", + "description": "Language of the knowledgebase. Please find the list of supported languages here.", + "maxLength": 100, + "minLength": 1 + } + } + }, + "FileDTO": { + "type": "object", + "description": "DTO to hold details of uploaded files.", + "additionalProperties": false, + "required": [ + "fileName", + "fileUri" + ], + "properties": { + "fileName": { + "type": "string", + "description": "File name. Supported file types are \".tsv\", \".pdf\", \".txt\", \".docx\", \".xlsx\".", + "maxLength": 200, + "minLength": 1 + }, + "fileUri": { + "type": "string", + "description": "Public URI of the file." + } + } + }, + "ReplaceKbDTO": { + "type": "object", + "description": "Post body schema for Replace KB operation.", + "additionalProperties": false, + "required": [ + "qnAList" + ], + "properties": { + "qnAList": { + "type": "array", + "description": "List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.", + "items": { + "$ref": "#/definitions/QnADTO" + } + } + } + }, + "QnADTO": { + "type": "object", + "description": "Q-A object.", + "additionalProperties": false, + "required": [ + "answer", + "questions" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique id for the Q-A.", + "format": "int32" + }, + "answer": { + "type": "string", + "description": "Answer text", + "maxLength": 25000, + "minLength": 1 + }, + "source": { + "type": "string", + "description": "Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs", + "maxLength": 300 + }, + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "maxLength": 100, + "minLength": 1, + "items": { + "type": "string" + } + }, + "metadata": { + "type": "array", + "description": "List of metadata associated with the answer.", + "maxLength": 10, + "items": { + "$ref": "#/definitions/MetadataDTO" + } + }, + "context": { + "description": "Context of a QnA", + "allOf": [ + { + "$ref": "#/definitions/ContextDTO" + } + ] + }, + "lastUpdatedTimestamp": { + "type": "string", + "description": "Timestamp when the QnA was last updated.", + "maxLength": 300 + } + } + }, + "ContextDTO": { + "type": "object", + "description": "Context associated with Qna.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not.\ntrue - Do not include this QnA as search result for queries without context\nfalse - ignores context and includes this QnA in search result" + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/PromptDTO" + } + } + } + }, + "PromptDTO": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt - used in ordering of the prompts", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.", + "format": "int32" + }, + "qna": { + "description": "QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object", + "allOf": [ + { + "$ref": "#/definitions/QnADTO" + } + ] + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt", + "maxLength": 200 + } + } + }, + "MetadataDTO": { + "type": "object", + "description": "Name - value pair of metadata.", + "additionalProperties": false, + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Metadata name.", + "maxLength": 100, + "minLength": 1 + }, + "value": { + "type": "string", + "description": "Metadata value.", + "maxLength": 500, + "minLength": 1 + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "properties": { + "error": { + "description": "The error object.", + "allOf": [ + { + "$ref": "#/definitions/Error" + } + ] + } + } + }, + "Error": { + "type": "object", + "description": "The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "required": [ + "code" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innerError": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "ErrorCode": { + "type": "string", + "description": "Human readable error code.", + "x-ms-enum": { + "name": "ErrorCodeType", + "modelAsString": true + }, + "enum": [ + "BadArgument", + "Forbidden", + "NotFound", + "KbNotFound", + "Unauthorized", + "Unspecified", + "EndpointKeysError", + "QuotaExceeded", + "QnaRuntimeError", + "SKULimitExceeded", + "OperationNotFound", + "ServiceError", + "ValidationFailure", + "ExtractionFailure" + ] + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "properties": { + "code": { + "type": "string", + "description": "A more specific error code than was provided by the containing error." + }, + "innerError": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "Operation": { + "type": "object", + "description": "Record to track long running operation.", + "additionalProperties": false, + "properties": { + "operationState": { + "description": "Operation state.", + "$ref": "#/definitions/OperationState" + }, + "createdTimestamp": { + "type": "string", + "description": "Timestamp when the operation was created." + }, + "lastActionTimestamp": { + "type": "string", + "description": "Timestamp when the current state was entered." + }, + "resourceLocation": { + "type": "string", + "description": "Relative URI to the target resource location for completed resources." + }, + "userId": { + "type": "string", + "description": "User Id" + }, + "operationId": { + "type": "string", + "description": "Operation Id." + }, + "errorResponse": { + "description": "Error details in case of failures.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "OperationState": { + "type": "string", + "description": "Enumeration of operation states.", + "x-ms-enum": { + "name": "OperationStateType", + "modelAsString": true + }, + "enum": [ + "Failed", + "NotStarted", + "Running", + "Succeeded" + ] + }, + "KnowledgebasesDTO": { + "type": "object", + "description": "Collection of knowledgebases owned by a user.", + "additionalProperties": false, + "properties": { + "knowledgebases": { + "type": "array", + "description": "Collection of knowledgebase records.", + "items": { + "$ref": "#/definitions/KnowledgebaseDTO" + } + } + } + }, + "KnowledgebaseDTO": { + "type": "object", + "description": "Response schema for CreateKb operation.", + "additionalProperties": false, + "properties": { + "id": { + "type": "string", + "description": "Unique id that identifies a knowledgebase." + }, + "hostName": { + "type": "string", + "description": "URL host name at which the knowledgebase is hosted." + }, + "lastAccessedTimestamp": { + "type": "string", + "description": "Time stamp at which the knowledgebase was last accessed (UTC)." + }, + "lastChangedTimestamp": { + "type": "string", + "description": "Time stamp at which the knowledgebase was last modified (UTC)." + }, + "lastPublishedTimestamp": { + "type": "string", + "description": "Time stamp at which the knowledgebase was last published (UTC)." + }, + "name": { + "type": "string", + "description": "Friendly name of the knowledgebase." + }, + "userId": { + "type": "string", + "description": "User who created / owns the knowledgebase." + }, + "urls": { + "type": "array", + "description": "URL sources from which Q-A were extracted and added to the knowledgebase.", + "items": { + "type": "string" + } + }, + "sources": { + "type": "array", + "description": "Custom sources from which Q-A were extracted or explicitly added to the knowledgebase.", + "items": { + "type": "string" + } + } + } + }, + "EndpointSettingsDTO": { + "type": "object", + "description": "Endpoint settings.", + "additionalProperties": false, + "properties": { + "activeLearning": { + "description": "Active Learning settings of the endpoint.", + "allOf": [ + { + "$ref": "#/definitions/ActiveLearningSettingsDTO" + } + ] + } + } + }, + "ActiveLearningSettingsDTO": { + "type": "object", + "description": "Active Learning settings of the endpoint.", + "additionalProperties": false, + "properties": { + "enable": { + "type": "string", + "description": "True/False string providing Active Learning" + } + } + }, + "WordAlterationsDTO": { + "type": "object", + "description": "Collection of word alterations.", + "additionalProperties": false, + "required": [ + "wordAlterations" + ], + "properties": { + "wordAlterations": { + "type": "array", + "description": "Collection of word alterations.", + "maxLength": 10000, + "items": { + "$ref": "#/definitions/AlterationsDTO" + } + } + } + }, + "AlterationsDTO": { + "type": "object", + "description": "Collection of words that are synonyms.", + "additionalProperties": false, + "required": [ + "alterations" + ], + "properties": { + "alterations": { + "type": "array", + "description": "Words that are synonymous with each other.", + "maxLength": 20, + "minLength": 1, + "items": { + "type": "string" + } + } + } + }, + "EndpointKeysDTO": { + "type": "object", + "description": "Schema for EndpointKeys generate/refresh operations.", + "additionalProperties": false, + "properties": { + "primaryEndpointKey": { + "type": "string", + "description": "Primary Access Key." + }, + "secondaryEndpointKey": { + "type": "string", + "description": "Secondary Access Key." + }, + "installedVersion": { + "type": "string", + "description": "Current version of runtime." + }, + "lastStableVersion": { + "type": "string", + "description": "Latest version of runtime." + }, + "language": { + "type": "string", + "description": "Language setting of runtime." + } + } + }, + "QueryDTO": { + "type": "object", + "description": "POST body schema to query the knowledgebase.", + "additionalProperties": false, + "properties": { + "qnaId": { + "type": "string", + "description": "Exact qnaId to fetch from the knowledgebase, this field takes priority over question." + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "description": "Max number of answers to be returned for the question.", + "format": "int32" + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "isTest": { + "type": "boolean", + "description": "Query against the test index." + }, + "scoreThreshold": { + "type": "number", + "description": "Minimum threshold score for answers." + }, + "context": { + "description": "Context object with previous QnA's information.", + "allOf": [ + { + "$ref": "#/definitions/QueryContextDTO" + } + ] + }, + "rankerType": { + "type": "string", + "description": "Optional field. Set to 'QuestionOnly' for using a question only Ranker." + }, + "strictFilters": { + "type": "array", + "description": "Find QnAs that are associated with the given list of metadata.", + "items": { + "$ref": "#/definitions/MetadataDTO" + } + }, + "strictFiltersCompoundOperationType": { + "type": "string", + "description": "Optional field. Set to 'OR' for using OR operation for strict filters.", + "x-ms-enum": { + "name": "StrictFiltersCompoundOperationType", + "modelAsString": true + }, + "enum": [ + "AND", + "OR" + ] + }, + "answerSpanRequest": { + "description": "To configure Answer span prediction feature.", + "allOf": [ + { + "$ref": "#/definitions/AnswerSpanRequestDTO" + } + ] + } + } + }, + "QueryContextDTO": { + "type": "object", + "description": "Context object with previous QnA's information.", + "additionalProperties": false, + "properties": { + "previousQnaId": { + "type": "integer", + "description": "Previous QnA Id - qnaId of the top result." + }, + "previousUserQuery": { + "type": "string", + "description": "Previous user query." + } + } + }, + "QnASearchResultList": { + "type": "object", + "description": "Represents List of Question Answers.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents Search Result list.", + "items": { + "$ref": "#/definitions/QnASearchResult" + } + } + } + }, + "QnASearchResult": { + "type": "object", + "description": "Represents Search Result.", + "additionalProperties": false, + "properties": { + "questions": { + "type": "array", + "description": "List of questions.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer." + }, + "score": { + "type": "number", + "description": "Search result score." + }, + "id": { + "type": "integer", + "description": "Id of the QnA result.", + "format": "int32" + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "array", + "description": "List of metadata.", + "items": { + "$ref": "#/definitions/MetadataDTO" + } + }, + "context": { + "type": "object", + "description": "Context object of the QnA", + "allOf": [ + { + "$ref": "#/definitions/ContextDTO" + } + ] + }, + "answerSpan": { + "type": "object", + "description": "Answer span object of QnA with respect to user's question.", + "allOf": [ + { + "$ref": "#/definitions/AnswerSpanResponseDTO" + } + ] + } + } + }, + "FeedbackRecordsDTO": { + "type": "object", + "description": "Active learning feedback records.", + "additionalProperties": false, + "properties": { + "feedbackRecords": { + "type": "array", + "description": "List of feedback records.", + "maxLength": 1000, + "items": { + "$ref": "#/definitions/FeedbackRecordDTO" + } + } + } + }, + "FeedbackRecordDTO": { + "type": "object", + "description": "Active learning feedback record.", + "additionalProperties": false, + "properties": { + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "userQuestion": { + "type": "string", + "description": "The suggested question being provided as feedback.", + "maxLength": 1000 + }, + "qnaId": { + "type": "integer", + "description": "The qnaId for which the suggested question is provided as feedback.", + "format": "int32" + } + } + }, + "AnswerSpanRequestDTO": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "additionalProperties": false, + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or Disable Answer Span prediction." + }, + "scoreThreshold": { + "type": "number", + "format": "double", + "description": "Minimum threshold score required to include an answer span." + }, + "topAnswersWithSpan": { + "type": "integer", + "description": "Number of Top answers to be considered for span prediction.", + "format": "int32", + "maximum": 10, + "minimum": 1 + } + } + }, + "AnswerSpanResponseDTO": { + "type": "object", + "description": "Answer span object of QnA.", + "additionalProperties": false, + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "score": { + "type": "number", + "description": "Predicted score of answer span.", + "format": "double" + }, + "startIndex": { + "type": "integer", + "description": "Start index of answer span in answer.", + "format": "int32" + }, + "endIndex": { + "type": "integer", + "description": "End index of answer span in answer.", + "format": "int32" + } + } + } + }, + "parameters": { + "Environment": { + "type": "string", + "name": "environment", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Specifies whether environment is Test or Prod.", + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + }, + "enum": [ + "Prod", + "Test" + ], + "x-ms-parameter-location": "method" + }, + "CreateKbPayload": { + "name": "createKbPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateKbDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "UpdateKb": { + "name": "updateKb", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateKbOperationDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "ReplaceKb": { + "name": "replaceKb", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReplaceKbDTO" + }, + "x-nullable": true, + "description": "An instance of ReplaceKbDTO which contains list of qnas to be uploaded", + "x-ms-parameter-location": "method" + }, + "KbId": { + "type": "string", + "name": "kbId", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Knowledgebase id.", + "x-ms-parameter-location": "method" + }, + "OperationId": { + "type": "string", + "name": "operationId", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Operation id.", + "x-ms-parameter-location": "method" + }, + "WordAlterations": { + "name": "wordAlterations", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordAlterationsDTO" + }, + "x-nullable": true, + "description": "New alterations data.", + "x-ms-parameter-location": "method" + }, + "KeyType": { + "type": "string", + "name": "keyType", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Type of Key", + "x-ms-parameter-location": "method" + }, + "GenerateAnswerPayload": { + "name": "generateAnswerPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "TrainPayload": { + "name": "trainPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FeedbackRecordsDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoint (e.g., https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "EndpointSettingsPayload": { + "name": "endpointSettingsPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EndpointSettingsDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulCreateKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulCreateKb.json new file mode 100644 index 000000000000..2f0bc8e9ee82 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulCreateKb.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "createKbPayload": { + "name": "QnA Maker FAQ", + "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": [] + }, + { + "id": 0, + "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": [ + "How do I programmatically create a KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ], + "context": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "displayText": "Update KB", + "qna": { + "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", + "questions": [ + "How do I programmatically update my KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ], + "context": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "displayText": "Refresh Endpoint Keys", + "qna": { + "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys", + "questions": [ + "How do I programmatically refresh endpoint keys?" + ] + } + } + ] + } + } + } + ] + } + } + ], + "urls": [ + "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-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" + } + ] + } + }, + "responses": { + "202": { + "headers": {}, + "body": { + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDelKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDelKb.json new file mode 100644 index 000000000000..bcd50173c37b --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDelKb.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDownloadKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDownloadKb.json new file mode 100644 index 000000000000..9c4bb3d38824 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulDownloadKb.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "environment": "Test" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "qnaDocuments": [ + { + "id": 1, + "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": [], + "context": { + "isContextOnly": false, + "prompts": [] + }, + "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00" + }, + { + "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": [ + "How do I programmatically create a KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ], + "context": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 3, + "displayText": "Update KB" + } + ] + }, + "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00" + }, + { + "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": "Editorial", + "questions": [ + "How do I programmatically update my KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ], + "context": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 4, + "displayText": "Refresh Endpoint Keys" + } + ] + }, + "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00" + }, + { + "id": 4, + "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys", + "source": "Editorial", + "questions": [ + "How do I programmatically refresh endpoint keys?" + ], + "metadata": [], + "context": { + "isContextOnly": false, + "prompts": [] + }, + "lastUpdatedTimestamp": "2020-08-27T16:00:30.272746+00:00" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGenAns.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGenAns.json new file mode 100644 index 000000000000..c225ade135db --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGenAns.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "generateAnswerPayload": { + "question": "How much time it takes to complete quickstart guide?", + "top": 6, + "isTest": true, + "context": { + "previousQnaId": 9, + "previousUserQuery": "Where are QnA Maker quickstarts?" + }, + "scoreThreshold": 20, + "strictFilters": [ + { + "name": "category", + "value": "api" + } + ], + "answerSpanRequest": { + "enable": true, + "scoreThreshold": 25, + "topAnswersWithSpan": 1 + }, + "userId": "sd53lsY=" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "answers": [ + { + "questions": [ + "Complete a quickstart" + ], + "answer": "We offer quickstarts in most popular programming languages, each designed to teach you basic design patterns, and have you running code in less than 10 minutes. See the following list for the quickstart for each feature.\n\n* [Get started with the LUIS client library](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-sdk)\n\n* [Get started with the LUIS portal](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/create-publish-knowledge-base)\n\n* [Get started with the LUIS REST APis](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-rest-curl)", + "score": 46.11, + "id": 9, + "source": "Editorial", + "metadata": [], + "context": { + "isContextOnly": false, + "prompts": [] + }, + "answerSpan": { + "text": "less than 10 minutes", + "score": 54.92, + "startIndex": 139, + "endIndex": 159 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAlts.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAlts.json new file mode 100644 index 000000000000..465b1152950e --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAlts.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "wordAlterations": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + }, + { + "alterations": [ + "webchat", + "web chat" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAltsForKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAltsForKb.json new file mode 100644 index 000000000000..dcd63a18be30 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetAltsForKb.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "wordAlterations": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + }, + { + "alterations": [ + "webchat", + "web chat" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpKeys.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpKeys.json new file mode 100644 index 000000000000..a32d6baa42de --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryEndpointKey": "73e88a14-694a-44d5-883b-184a68aa8530", + "secondaryEndpointKey": "b2c98c16-ca31-4294-8626-6c57454a5063", + "installedVersion": "4.0.5", + "lastStableVersion": "4.0.6" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpSettings.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpSettings.json new file mode 100644 index 000000000000..97cc7fcac360 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetEpSettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "activeLearning": { + "enable": "True" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetKb.json new file mode 100644 index 000000000000..fbec604c70f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetKb.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "hostName": "https://myqnamakerbot.azurewebsites.net", + "lastAccessedTimestamp": "2018-03-16T10:59:46Z", + "lastChangedTimestamp": "2018-03-16T10:58:10Z", + "lastPublishedTimestamp": "2018-03-16T10:59:56Z", + "name": "My QnA Maker Bot", + "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1", + "urls": [ + "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" + ], + "sources": [ + "Custom Editorial", + "SurfaceManual.pdf" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetOps.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetOps.json new file mode 100644 index 000000000000..85e84d90aed9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulGetOps.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "operationState": "Succeeded", + "createdTimestamp": "2018-03-19T07:38:46Z", + "lastActionTimestamp": "2018-03-19T07:39:29Z", + "resourceLocation": "https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "userId": "86bb8390-56c0-42c2-9f81-3de161981191", + "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulKbsResponse.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulKbsResponse.json new file mode 100644 index 000000000000..aab19445e730 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulKbsResponse.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "knowledgebases": [ + { + "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "hostName": "https://myqnamakerbot.azurewebsites.net", + "lastAccessedTimestamp": "2018-03-16T10:59:46Z", + "lastChangedTimestamp": "2018-03-16T10:58:10Z", + "lastPublishedTimestamp": "2018-03-16T10:59:56Z", + "name": "My QnA Maker Bot", + "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1", + "urls": [ + "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" + ], + "sources": [ + "Custom Editorial", + "SurfaceManual.pdf" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulPubKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulPubKb.json new file mode 100644 index 000000000000..bcd50173c37b --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulPubKb.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulRepKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulRepKb.json new file mode 100644 index 000000000000..fd6ba1224539 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulRepKb.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "replaceKb": { + "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": [] + }, + { + "id": 0, + "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": [ + "How do I programmatically create a KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ] + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAlts.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAlts.json new file mode 100644 index 000000000000..ba8facefde92 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAlts.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "wordAlterations": { + "wordAlterations": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + }, + { + "alterations": [ + "webchat", + "web chat" + ] + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAltsForKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAltsForKb.json new file mode 100644 index 000000000000..6dc5ca492391 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetAltsForKb.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", + "wordAlterations": { + "wordAlterations": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + }, + { + "alterations": [ + "webchat", + "web chat" + ] + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpKeys.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpKeys.json new file mode 100644 index 000000000000..925d4f65d77d --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "keyType": "PrimaryKey" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryEndpointKey": "73e88a14-694a-44d5-883b-184a68aa8530", + "secondaryEndpointKey": "b2c98c16-ca31-4294-8626-6c57454a5063", + "installedVersion": "4.0.5", + "lastStableVersion": "4.0.6" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpSettings.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpSettings.json new file mode 100644 index 000000000000..468c0b59680a --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulSetEpSettings.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "endpointSettingsPayload": { + "activeLearning": { + "enable": "True" + } + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulTrain.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulTrain.json new file mode 100644 index 000000000000..4dabb5d81c35 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulTrain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{Primary/Secondary Endpoint Key}", + "Content-Type": "application/json", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "trainPayload": { + "feedbackRecords": [ + { + "userId": "sd53lsY=", + "userQuestion": "qna maker with luis", + "qnaId": 4 + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulUpdKb.json b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulUpdKb.json new file mode 100644 index 000000000000..3c717ca27123 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/preview/v5.0-preview.1/examples/SuccessfulUpdKb.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "updateKb": { + "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 + ] + } + } + ] + } + } + }, + "responses": { + "202": { + "headers": {}, + "body": { + "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" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md index 214d27ace71d..ac3d12f87b38 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md @@ -14,6 +14,7 @@ go: batch: - tag: release_4_0 - tag: runtime_release_4_0 + - tag: release_5_0_preview.1 ``` ### Tag: release_4_0 and go @@ -35,3 +36,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_5_0_preview.1' && $(go) +namespace: qnamaker +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/cognitiveservices/v5.0-preview.1/$(namespace) +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.md index 23b55def218b..df7bb80d5701 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.md @@ -5,6 +5,8 @@ Configuration for generating QnAMaker SDK. The current release is `release_4_0`. +A preview release `release_5_0_preview.1` is also available. + ``` yaml @@ -12,21 +14,33 @@ tag: release_4_0 add-credentials: true openapi-type: data-plane ``` -# Releases -### Release 4.0 -These settings apply only when `--tag=release_4_0` is specified on the command line. +``` yaml +tag: runtime_release_4_0 +add-credentials: true +openapi-type: data-plane +``` -``` yaml $(tag) == 'release_4_0' -input-file: stable/v4.0/QnAMaker.json +``` yaml +tag: release_5_0_preview.1 +add-credentials: true +openapi-type: data-plane ``` ``` yaml -tag: runtime_release_4_0 +tag: runtime_release_preview.1 add-credentials: true openapi-type: data-plane ``` -# Runtime Releases + +# Releases + +### Release 4.0 +These settings apply only when `--tag=release_4_0` is specified on the command line. + +``` yaml $(tag) == 'release_4_0' +input-file: stable/v4.0/QnAMaker.json +``` ### Runtime Release 4.0 These settings apply only when `--tag=runtime_release_4_0` is specified on the command line. @@ -35,10 +49,18 @@ These settings apply only when `--tag=runtime_release_4_0` is specified on the c input-file: stable/v4.0/QnAMakerRuntime.json ``` +### Release 5.0-preview.1 +These settings apply only when `--tag=release_5_0_preview.1` is specified on the command line. + +``` yaml $(tag) == 'release_5_0_preview.1' +input-file: preview/v5.0-preview.1/QnAMaker.json +``` + ``` yaml batch: - tag: release_4_0 - tag: runtime_release_4_0 + - tag: release_5_0_preview.1 ``` ## Swagger to SDK @@ -59,9 +81,10 @@ swagger-to-sdk: ``` -## CSharp Settings -These settings apply only when `--csharp` is specified on the command line. -``` yaml $(csharp) +## CSharp Settings Release 4.0 +These settings apply only when `--csharp --tag=release_4_0` is specified on the command line. + +``` yaml $(csharp) && $(tag) == 'release_4_0' csharp: sync-methods: None license-header: MICROSOFT_MIT_NO_VERSION @@ -71,6 +94,29 @@ csharp: clear-output-folder: true ``` +``` yaml $(csharp) && $(tag) == 'runtime_release_4_0' +csharp: + sync-methods: None + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker + output-folder: $(csharp-sdks-folder)/CognitiveServices/Knowledge.QnAMaker/src/Generated + clear-output-folder: true +``` +## CSharp Settings Release 5.0-preview.1 + +These settings apply only when `--csharp --tag=release_5_0_preview.1` is specified on the command line. + +``` yaml $(csharp) && $(tag) == 'release_5_0_preview.1' +csharp: + sync-methods: None + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker + output-folder: $(csharp-sdks-folder)/CognitiveServices/Knowledge.QnAMaker/preview/src/Generated + clear-output-folder: true +``` + ## Python See configuration in [readme.python.md](./readme.python.md) @@ -81,10 +127,10 @@ See configuration in [readme.go.md](./readme.go.md) ## Java -These settings apply only when `--java` is specified on the command line. +These settings apply only when `--java --tag=release_4_0` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(java) +``` yaml $(java) && $(tag) == 'release_4_0' java: azure-arm: true namespace: com.microsoft.azure.cognitiveservices.knowledge.qnamaker @@ -95,6 +141,21 @@ java: with-single-async-method: true ``` + +These settings apply only when `--java --tag=release_5_0_preview` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) && $(tag) == 'release_5_0_preview.1' +java: + azure-arm: true + namespace: com.microsoft.azure.cognitiveservices.knowledge.qnamaker + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/knowledge/qnamaker/preview + with-optional-parameters: true + with-single-async-method: true +``` + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -109,7 +170,7 @@ require: $(this-folder)/../../../../profiles/readme.md input-file: - $(this-folder)/stable/v4.0/QnAMaker.json - $(this-folder)/stable/v4.0/QnAMakerRuntime.json - + - $(this-folder)/preview/v5.0-preview.1/QnAMaker.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md index 4a819e11716c..3f98fa061bd4 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md @@ -1,9 +1,9 @@ ## Node.js -These settings apply only when `--nodejs` is specified on the command line. +These settings apply only when `--nodejs --tag=release_4_0` is specified on the command line. Please also specify `--node-sdks-folder=`. -``` yaml $(nodejs) +``` yaml $(tag) == 'release_4_0' && $(nodejs) nodejs: package-name: azure-cognitiveservices-qnamaker output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesQnAMaker @@ -12,3 +12,16 @@ nodejs: generate-package-json: true generate-readme-md: true ``` + +These settings apply only when `--nodejs --tag=release_5_0_preview.1` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(tag) == 'release_5_0_preview.1' && $(nodejs) +nodejs: + package-name: azure-cognitiveservices-qnamaker-preview + output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesQnAMaker/preview + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md index 28c107b25da3..6be17bcb15d8 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md @@ -12,11 +12,18 @@ package-name: azure-cognitiveservices-knowledge-qnamaker no-namespace-folders: true clear-output-folder: true ``` + ``` yaml $(tag) == 'release_4_0' namespace: azure.cognitiveservices.knowledge.qnamaker.authoring output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/authoring ``` + ``` yaml $(tag) == 'runtime_release_4_0' namespace: azure.cognitiveservices.knowledge.qnamaker.runtime output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/runtime ``` + +``` yaml $(tag) == 'release_5_0_preview.1' +namespace: azure.cognitiveservices.knowledge.qnamaker.preview +output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker/preview/ +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md index 9466e290b772..cbcfc7220bdd 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md @@ -4,7 +4,7 @@ These settings apply only when `--ruby` is specified on the command line. ``` yaml package-name: azure_cognitiveservices_qnamaker -package-version: "0.16.0" +package-version: "1.0.0" azure-arm: true ``` @@ -13,6 +13,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: - tag: release_4_0 + - tag: release_5_0_preview.1 ``` ### Tag: release_4_0 and ruby @@ -23,4 +24,15 @@ Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_5_0_preview.1' && $(ruby) +namespace: "Azure::CognitiveServices::Qnamaker::V5_0_preview_1" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_qnamaker/lib ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md index f796e6157012..14a2b6368a71 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md @@ -3,10 +3,21 @@ These settings apply only when `--typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. -``` yaml $(typescript) +``` yaml $(tag) == 'release_4_0' && $(typescript) typescript: package-name: "@azure/cognitiveservices-qnamaker" output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-qnamaker" azure-arm: false generate-metadata: true ``` + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(tag) == 'release_5_0_preview.1' && $(typescript) +typescript: + package-name: "@azure/cognitiveservices-qnamaker" + output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-qnamaker/preview" + azure-arm: false + generate-metadata: true +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index 2afdea67435e..d4144409a4c4 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -1446,7 +1446,7 @@ }, "Endpoint": { "name": "Endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "description": "Supported Cognitive Services endpoint (e.g., https://< qnamaker-resource-name> .api.cognitiveservices.azure.com).", "x-ms-parameter-location": "client", "required": true, "type": "string",