Question Answering Projects - Update Sources

  • Reference
Service:
Azure AI Services
API Version:
2021-10-01

Updates the sources of a project.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01

URI Parameters

Name In Required Type Description
Endpoint
 path True

string

Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName
 path True

string

The name of the project to use.
api-version
 query True

string

Client API version.

Request Header

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Name Type Description
body

UpdateSourceRecord[]

Update sources parameters of a project.

Responses

Name Type Description
202 Accepted

A successful call results with an Operation-Location header used to check the status of the job.

Headers

Operation-Location: string
Other Status Codes

ErrorResponse

Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1/sources?api-version=2021-10-01


[
  {
    "op": "add",
    "value": {
      "displayName": "source3",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
      "sourceKind": "url",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
    }
  },
  {
    "op": "replace",
    "value": {
      "displayName": "source1",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "refresh": true,
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    }
  },
  {
    "op": "delete",
    "value": {
      "displayName": "source2",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
      "sourceKind": "file",
      "source": "surface-guide.pdf"
    }
  }
]

Sample response

Status code:
202 
Operation-Location: job1

Definitions

Name Description
Error

The error object.
ErrorCode

Human-readable error code.
ErrorResponse

Error response.
InnerErrorCode

Human-readable error code.
InnerErrorModel

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.
sourceContentStructureKind

Content structure type for sources.
sourceKind

Supported source types.
updateOperationKind

Update operation type for assets.
UpdateQnaSourceRecord

Update source record.
UpdateSourceRecord

Source to be updated.

Error

The error object.

Name Type Description
code

ErrorCode

One of a server-defined set of error codes.
details

Error[]

An array of details about specific errors that led to this reported error.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

ErrorCode

Human-readable error code.

Name Type Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

ErrorResponse

Error response.

Name Type Description
error

Error

The error object.

InnerErrorCode

Human-readable error code.

Name Type Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

ExtractionFailure

string

InvalidParameterValue

string

InvalidRequest

string

KnowledgeBaseNotFound

string

InnerErrorModel

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.

Name Type Description
code

InnerErrorCode

One of a server-defined set of error codes.
details

object

Error details.
innererror

InnerErrorModel

An object containing more specific information than the current object about the error.
message

string

Error message.
target

string

Error target.

sourceContentStructureKind

Content structure type for sources.

Name Type Description
unstructured

string

sourceKind

Supported source types.

Name Type Description
file

string

url

string

updateOperationKind

Update operation type for assets.

Name Type Description
add

string

delete

string

replace

string

UpdateQnaSourceRecord

Update source record.

Name Type Default value Description
contentStructureKind

sourceContentStructureKind

Unstructured

Content structure type for sources.
displayName

string

Friendly name of the Source.
refresh

boolean

Boolean flag used to refresh data from the Source.
source

string

Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source.
sourceKind

sourceKind

url

Supported source types.
sourceUri

string

URI location for the file or url.

UpdateSourceRecord

Source to be updated.

Name Type Description
op

updateOperationKind

Update operation type for assets.
value

UpdateQnaSourceRecord

Update source record.