The identity and technical contract details declared by the specification.
TextAnalysisAuthoringModelFile
object
Represents the properties for the model file.
2 properties
2 required
WordAlterations
object
Collection of word alterations.
1 property
1 required
TextAnalysisAuthoringResourceMetadata
object
Represents metadata for the Azure resource..
3 properties
3 required
TextAnalysisAuthoringAssignedResourceDeploymentsMetadata
object
Represents the metadata for deployments assigned to a resource.
2 properties
2 required
TextAnalysisAuthoringAssignedProjectDeploymentsMetadata
object
Represents the metadata for assigned deployments for a project.
2 properties
2 required
TextAnalysisAuthoringWarning
object
Represents a warning that was encountered while executing the request.
2 properties
2 required
TextAnalysisAuthoringDeploymentResource
object
Represents an Azure resource assigned to a deployment.
2 properties
2 required
ConversationalAnalysisAuthoringEvaluationKind
string
TextAnalysisAuthoringExportedModelManifest
object
Represents the properties for the exported model manifest.
1 property
1 required
TextAnalysisAuthoringCopyAuthorizationOptions
object
Represents the options for authorizing a project copy to the current Azure resource.
3 properties
1 required
TextAnalysisAuthoringExportedProjectAssets
object
Represents the assets of an exported project.
1 property
1 required
TextAnalysisAuthoringSwapDeploymentsOptions
object
Represents the options for swapping two deployments together.
2 properties
2 required
ConversationalAnalysisAuthoringCopyProjectOptions
object
Represents the options for copying an existing project to another Azure resource.
6 properties
6 required
ConversationalAnalysisAuthoringProjectDeletionJobState
object
Represents the state of a project deletion job.
SynonymAsset
array
Collection of synonyms.
ConversationalAnalysisAuthoringDeploymentJobState
object
Represents the state of a deployment job.
TextAnalysisAuthoringProjectKind
string
ConversationalAnalysisAuthoringTrainingMode
string
RetrieveQnaRecord
QnA Record with last updated date-time.
SourceDisplayNameParameter
object
1 property
TextAnalysisAuthoringProjectDeletionJobState
object
Represents the state of a project deletion job.
QnaSourceMetadata
object
Input source file or url details.
5 properties
3 required
TextAnalysisAuthoringProjectsMetadata
object
Represents a list of retrieved projects' metadata.
2 properties
2 required
ConversationalAnalysisAuthoringEntityEvaluationSummary
object
Represents the evaluation result for an entity.
7 properties
7 required
ConversationalAnalysisAuthoringTrainingJobs
object
Represents a list of retrieved training jobs.
2 properties
2 required
ConversationalAnalysisAuthoringProjectsMetadata
object
Represents a list of retrieved projects' metadata.
2 properties
2 required
FeedbackRecord
object
Feedback Record for Active Learning.
3 properties
ConversationalAnalysisAuthoringExportProjectJobState
object
Represents the state of an export job.
1 property
TextAnalysisAuthoringTrainingConfigVersions
object
Represents a list of training config versions.
2 properties
2 required
ExportJobState
Export job status, project metadata, and assets.
Assets
object
All assets for this project.
2 properties
SuggestedQuestion
object
Question suggested by the Active Learning feature.
3 properties
TextAnalysisAuthoringJobStatus
string
ProjectMetadata
object
Represents the project.
8 properties
TextAnalysisAuthoringStringIndexType
string
ConversationalAnalysisAuthoringProjectTrainedModels
object
Represents a list of retrieved trained models.
2 properties
2 required
ConversationalAnalysisAuthoringDeploymentResource
object
Represents an Azure resource assigned to a deployment.
2 properties
2 required
ConversationalAnalysisAuthoringSwapDeploymentsOptions
object
Represents the options for swapping two deployments together.
2 properties
2 required
TextAnalysisAuthoringLoadSnapshotJobState
object
Represents the state of loading a snapshot job.
LastUpdatedDateTimeParameter
object
Last updated date-time parameter.
1 property
TextAnalysisAuthoringProjectSettings
object
Represents the settings used to define the project behavior.
5 properties
TextAnalysisAuthoringCopyProjectOptions
object
Represents the options for copying an existing project to another Azure resource.
6 properties
6 required
ConversationalAnalysisAuthoringDeploymentResourcesJobState
object
Represents the state of a deployment resources job.
QnaSourceKind
string
Supported source types.
ConversationalAnalysisAuthoringAssignedDeploymentResources
object
Represents the assigned deployment resources.
2 properties
2 required
SynonymAssets
object
All synonym assets for this project.
2 properties
TextAnalysisAuthoringExportedTrainedModels
object
Represents a list of exported trained models.
2 properties
2 required
ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata
object
Represents the metadata for an assigned deployment
3 properties
3 required
TextAnalysisAuthoringProjectMetadata
object
Represents the metadata of a project.
11 properties
6 required
TextAnalysisAuthoringProjectDeployments
object
Represents a list of retrieved deployments.
2 properties
2 required
UpdateQnaRecord
object
QnA record to be updated.
2 properties
2 required
TextAnalysisAuthoringEvaluationJobResult
object
4 properties
4 required
UpdateSourcesOptions
array
A list of sources to be updated.
JobState
Job state represents the job metadata and any errors.
ConversationalAnalysisAuthoringProjectMetadata
object
Represents the metadata of a project.
11 properties
5 required
QnaDialog
object
Dialog associated with QnA Record.
2 properties
TextAnalysisAuthoringProjectTrainedModel
object
Represents a trained model.
7 properties
7 required
ConversationalAnalysisAuthoringEvaluationResults
object
Represent a list of utterances' evaluation results.
2 properties
2 required
TextAnalysisAuthoringPrebuiltEntity
object
Represents a supported prebuilt entity.
3 properties
3 required
ProjectDeploymentsList
array
List of deployments of a project.
TextAnalysisAuthoringExportedModelJobState
object
Represents the state of a job to create or updated an exported model.
ProjectDeployments
object
All deployments of a project.
2 properties
ConversationalAnalysisAuthoringEvaluationJobResult
object
4 properties
4 required
TextAnalysisAuthoringProjectTrainedModels
object
Represents a list of retrieved trained models.
2 properties
2 required
ConversationalAnalysisAuthoringSupportedLanguages
object
Represents a list of retrieved languages.
2 properties
2 required
SuggestedQuestionsCluster
object
Active Learning suggested questions cluster details.
2 properties
ConversationalAnalysisAuthoringEntitiesEvaluationSummary
object
Represents the evaluation result summary for the project's entities.
8 properties
8 required
ConversationalAnalysisAuthoringCopyProjectJobState
object
Represents the state of a copy job.
FeedbackRecords
array
A list of Feedback Records for Active Learning.
ConversationalAnalysisAuthoringProjectSettings
object
Represents the settings used to define the project behavior.
1 property
1 required
ConversationalAnalysisAuthoringIntentsEvaluationSummary
object
Represents the evaluation summary for the project's intents.
8 properties
8 required
QnaRecord
object
QnA record.
7 properties
ConversationalAnalysisAuthoringEvaluationOptions
object
Represents the options used running the evaluation.
3 properties
TextAnalysisAuthoringAssignedDeploymentResource
object
Represents the assigned deployment resource.
2 properties
2 required
ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions
object
Represents the options for assigning Azure resources to a project.
1 property
1 required
TextAnalysisAuthoringDocumentEvaluationResult
object
Represents the evaluation result of a document.
3 properties
3 required
TextAnalysisAuthoringTrainingJobs
object
Represents a list of retrieved training jobs.
2 properties
2 required
ConversationalAnalysisAuthoringImportProjectJobState
object
Represents the state of an import job.
TextAnalysisAuthoringAssignedProjectDeploymentMetadata
object
Represents the metadata for an assigned deployment
3 properties
3 required
TextAnalysisAuthoringAssignedDeploymentResources
object
Represents the assigned deployment resources.
2 properties
2 required
ExportJobResultUrl
object
URL to download the result of the Export Job.
1 property
1 required
ImportQnaAsset
array
List of QnA records to import.
ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata
object
Represents the metadata for assigned deployments for a project.
2 properties
2 required
TextAnalysisAuthoringTrainingJobResult
object
Represents the output of a training job.
5 properties
3 required
TextAnalysisAuthoringSupportedLanguages
object
Represents a list of retrieved languages.
2 properties
2 required
ConversationalAnalysisAuthoringJobState
object
Represents a job's state.
7 properties
4 required
TextAnalysisAuthoringSupportedLanguage
object
Represents a supported language.
2 properties
2 required
ConversationalAnalysisAuthoringWarning
object
Represents a warning that was encountered while executing the request.
2 properties
2 required
ConversationalAnalysisAuthoringTrainingJobResult
object
Represents the output of a training job.
6 properties
3 required
TextAnalysisAuthoringCopyProjectJobState
object
Represents the state of a copy job.
TextAnalysisAuthoringImportProjectJobState
object
Represents the state of an import job.
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult
object
Represents the comparison between the expected and predicted entities for an utterance.
2 properties
2 required
Errors
object
Collection of Error types.
1 property
TextAnalysisAuthoringTrainingConfigVersion
object
Represents a training config version.
2 properties
2 required
TextAnalysisAuthoringTrainingJobState
object
Represents the state of a training job.
1 property
1 required
UpdateOperationKind
string
Update operation type for assets.
QnaAssets
object
All QnA assets for the project.
2 properties
ConversationalAnalysisAuthoringEvaluationSummary
object
Represents the evaluation result summary.
3 properties
2 required
ConversationalAnalysisAuthoringTrainingJobOptions
object
Represents the options for starting a new training job.
4 properties
2 required
ConversationalAnalysisAuthoringConfusionMatrixCell
object
Represents a cell in a confusion matrix.
2 properties
2 required
TextAnalysisAuthoringEvaluationOptions
object
Represents the options used running the evaluation.
3 properties
ImportQnaRecord
Import QnA Record.
TextAnalysisAuthoringUnassignDeploymentResourcesOptions
object
Represents the options to unassign Azure resources from a project.
1 property
1 required
ConversationalAnalysisAuthoringConfusionMatrixRow
object
JobStatus
string
Job Status.
ProjectsMetadata
object
Collection of projects metadata and global settings.
2 properties
ConversationalAnalysisAuthoringExportedProject
object
Represents an exported project.
4 properties
3 required
ConversationalAnalysisAuthoringConfusionMatrix
object
ConversationalAnalysisAuthoringUtteranceEvaluationResult
object
Represents the evaluation result for an utterance.
4 properties
4 required
TextAnalysisAuthoringDeleteDeploymentOptions
object
Represents the options for deleting a project deployment.
1 property
ConversationalAnalysisAuthoringPrebuiltEntities
object
Represents a list of the retrieved supported prebuilt entities.
2 properties
2 required
QnaPrompt
object
Prompt for an answer.
4 properties
TextAnalysisAuthoringAssignDeploymentResourcesOptions
object
Represents the options for assigning Azure resources to a project.
1 property
1 required
ConversationalAnalysisAuthoringAssignedDeploymentResource
object
Represents the assigned deployment resource.
2 properties
2 required
UpdateQnaOptions
array
A list of QnAs to be updated.
ConversationalAnalysisAuthoringProjectKind
string
ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata
object
Represents the metadata for deployments assigned to a resource.
2 properties
2 required
TextAnalysisAuthoringTrainingJobOptions
object
Represents the options for starting a new training job.
3 properties
2 required
ConversationalAnalysisAuthoringProjectDeployment
object
Represents a project deployment.
7 properties
7 required
TextAnalysisAuthoringDeploymentJobState
object
Represents the state of a deployment job.
ConversationalAnalysisAuthoringEvaluationJobState
object
Represents the state of a evaluation job.
1 property
1 required
SourceContentStructureKind
string
Content structure type for sources.
TextAnalysisAuthoringExportProjectJobState
object
Represents the state of an export job.
1 property
ConversationalAnalysisAuthoringCreateDeploymentOptions
object
Represents the options for creating or updating a project deployment.
2 properties
1 required
ImportJobOptions
object
Project assets the needs to be imported.
3 properties
TextAnalysisAuthoringCreateDeploymentOptions
object
Represents the options for creating or updating a project deployment.
2 properties
1 required
ConversationalAnalysisAuthoringExportedProjectAssets
object
Represents the assets of an exported project.
1 property
1 required
ConversationalAnalysisAuthoringCopyAuthorizationOptions
object
Represents the options for authorizing a project copy to the current Azure resource.
3 properties
1 required
ConversationalAnalysisAuthoringIntentEvaluationSummary
object
The evaluation summary for an intent.
7 properties
7 required
ConversationalAnalysisAuthoringStringIndexType
string
TextAnalysisAuthoringSubTrainingJobState
object
Represents the detailed state of a training sub-operation.
4 properties
2 required
ConversationalAnalysisAuthoringDeleteDeploymentOptions
object
Represents the options for deleting a project deployment.
1 property
ConversationalAnalysisAuthoringResourceMetadata
object
Represents metadata for the Azure resource..
3 properties
3 required
ProjectSettings
object
Configurable settings of the Project.
1 property
TextAnalysisAuthoringEvaluationJobState
object
Represents the state of a evaluation job.
1 property
1 required
TextAnalysisAuthoringExportedModelOptions
object
Represents the options for creating or replacing an exported model.
1 property
1 required
TextAnalysisAuthoringEvaluationSummary
object
Represents the summary for an evaluation operation.
2 properties
2 required
ActiveLearningFeedback
object
Feedback for Active Learning.
1 property
UpdateQnaSourceRecord
Update source record.
TextAnalysisAuthoringExportedProject
object
Represents an exported project.
4 properties
3 required
TextAnalysisAuthoringEvaluationResults
object
Represents a list of results for an evaluation operation.
2 properties
2 required
TextAnalysisAuthoringProjectDeployment
object
Represents a project deployment.
7 properties
7 required
CreateProjectOptions
object
Parameters needed to create the project.
4 properties
1 required
ConversationalAnalysisAuthoringProjectTrainedModel
object
Represents a trained model.
7 properties
7 required
ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions
object
Represents the options to unassign Azure resources from a project.
1 property
1 required
ConversationalAnalysisAuthoringJobStatus
string
TextAnalysisAuthoringCreateProjectOptions
object
Represents the options used to create or update a project.
7 properties
4 required
ConversationalAnalysisAuthoringTrainingConfigVersions
object
Represents a list of training config versions.
2 properties
2 required
ConversationalAnalysisAuthoringLoadSnapshotJobState
object
Represents the state of loading a snapshot job.
QnaAsset
array
List of QnA records.
RefreshSourceOptions
object
Boolean flag used to refresh data from the Source.
1 property
ConversationalAnalysisAuthoringSubTrainingJobState
object
Represents the detailed state of a training sub-operation.
4 properties
2 required
QnaSourcesMetadata
array
Custom sources from which QnAs were extracted or explicitly added to the project.
QnaSourceRecord
Custom source record with last updated date-time.
ConversationalAnalysisAuthoringCreateProjectOptions
object
Represents the options used to create or update a project.
7 properties
3 required
TextAnalysisAuthoringJobState
object
Represents a job's state.
7 properties
4 required
ConversationalAnalysisAuthoringTrainingJobState
object
Represents the state of a training job.
1 property
1 required
TextAnalysisAuthoringPrebuiltEntities
object
Represents a list of the retrieved supported prebuilt entities.
2 properties
2 required
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult
object
Represents the comparison between the expected and the predicted intent for an utterance.
2 properties
2 required
ProjectDeployment
object
Project deployment details.
2 properties
UpdateSourceRecord
object
Source to be updated.
2 properties
2 required
ConversationalAnalysisAuthoringTrainingConfigVersion
object
Represents a training config version.
2 properties
2 required
TextAnalysisAuthoringDeploymentResourcesJobState
object
Represents the state of a deployment resources job.
ConversationalAnalysisAuthoringSupportedLanguage
object
Represents a supported language.
2 properties
2 required
QnaSources
object
All QnA sources for the project.
2 properties
ConversationalAnalysisAuthoringPrebuiltEntity
object
Represents a supported prebuilt entity.
3 properties
3 required
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult
object
Represents the evaluation output of an entity label or prediction.
3 properties
3 required
JobMetadata
object
Represents the job metadata.
5 properties
4 required
TextAnalysisAuthoringExportedTrainedModel
object
Represents an exported trained model.
6 properties
6 required
TextAnalysisAuthoringEvaluationKind
string
ConversationalAnalysisAuthoringProjectDeployments
object
Represents a list of retrieved deployments.
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.