Share via


Azure.AI.Language.QuestionAnswering.Authoring Namespace

Classes

Name Description
ActiveLearningFeedback

Feedback for Active Learning.

AILanguageQuestionAnsweringAuthoringModelFactory

Model factory for models.

AzureAILanguageQuestionAnsweringAuthoringContext

Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information see 'https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md'

FeedbackRecord

Feedback Record for Active Learning.

ImportFiles

Collection of files containing project assets that need to be imported.

ImportJobOptions

Project assets that need to be imported.

ImportQnaRecord

Import QnA Record.

KnowledgeBaseFile

A file in an HTTP request, response, or multipart payload.

Files have a special meaning that the HTTP library understands. When the body of an HTTP request, response, or multipart payload is effectively an instance of TypeSpec.Http.File or any type that extends it, the operation is treated as a file upload or download.

When using file bodies, the fields of the file model are defined to come from particular locations by default:

  • contentType: The Content-Type header of the request, response, or multipart payload (CANNOT be overridden or changed).
  • contents: The body of the request, response, or multipart payload (CANNOT be overridden or changed).
  • filename: The filename parameter value of the Content-Disposition header of the response or multipart payload (MAY be overridden or changed).

A File may be used as a normal structured JSON object in a request or response, if the request specifies an explicit Content-Type header. In this case, the entire File model is serialized as if it were any other model. In a JSON payload, it will have a structure like:

{
  "contentType": <string?>,
  "filename": <string?>,
  "contents": <string, base64>
}

The contentType within the file defines what media types the data inside the file can be, but if the specification defines a Content-Type for the payload as HTTP metadata, that Content-Type metadata defines how the file is serialized. See the examples below for more information.

NOTE: The filename and contentType fields are optional. Furthermore, the default location of filename (Content-Disposition: <disposition>; filename=<filename>) is only valid in HTTP responses and multipart payloads. If you wish to send the filename in a request, you must use HTTP metadata decorators to describe the location of the filename field. You can combine the metadata decorators with @visibility to control when the filename location is overridden, as shown in the examples below.

ProjectDeployment

Project deployment details.

ProjectDeploymentJobState

Job state represents the job metadata and any errors.

ProjectSettings

Configurable settings of the Project.

QuestionAnsweringAuthoringAssets

All assets for this project.

QuestionAnsweringAuthoringClient

The QuestionAnsweringAuthoring service client.

QuestionAnsweringAuthoringClientOptions

Client options for QuestionAnsweringAuthoringClient.

QuestionAnsweringAuthoringDialog

Dialog associated with QnA Record.

QuestionAnsweringAuthoringError

The error object.

QuestionAnsweringAuthoringExportJobState

Export job status, project metadata, and assets.

QuestionAnsweringAuthoringImportJobState

Import job status, project metadata, and assets.

QuestionAnsweringAuthoringInnerErrorModel

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.

QuestionAnsweringAuthoringProjectDeletionJobState

Represents the state of a project deletion job.

QuestionAnsweringAuthoringPrompt

Prompt for an answer.

QuestionAnsweringAuthoringRecord

QnA record.

QuestionAnsweringAuthoringSourceRecord

Custom source record with last updated date-time.

QuestionAnsweringAuthoringUpdateQnasJobState

Job state represents the job metadata and any errors.

QuestionAnsweringAuthoringUpdateSourcesJobState

Job state represents the job metadata and any errors.

QuestionAnsweringProject

Represents the project.

RetrieveQnaRecord

QnA Record with last updated date-time.

SuggestedQuestion

Question suggested by the Active Learning feature.

SuggestedQuestionsCluster

Active Learning suggested questions cluster details.

SynonymAssets

Request payload for updating synonyms.

WordAlterationsGroups

Collection of word alterations.

Structs

Name Description
AssetKind

Kind of the asset of the project.

FileFormat

Knowledge base Import or Export format.

KnowledgeBaseSourceKind

Supported source types.

QuestionAnsweringAuthoringAudience

Cloud audiences available for Question Answering Authoring.

QuestionAnsweringAuthoringErrorCode

Human-readable error code.

QuestionAnsweringAuthoringInnerErrorCode

Human-readable error code.

QuestionAnsweringAuthoringJobStatus

Job Status.

SourceContentStructureKind

Content structure type for sources.

Enums

Name Description
QuestionAnsweringAuthoringClientOptions.ServiceVersion

The version of the service to use.