From 3ad59d7baa19f2c01325c69ddc3e05db5e67c6cd Mon Sep 17 00:00:00 2001 From: Tien Suwandy Date: Fri, 13 Nov 2020 10:00:26 -0800 Subject: [PATCH] updated API ref to point to Azure docs (#6105) --- Orchestrator/docs/API_reference.md | 292 ----------------------------- Orchestrator/docs/Overview.md | 2 +- 2 files changed, 1 insertion(+), 293 deletions(-) delete mode 100644 Orchestrator/docs/API_reference.md diff --git a/Orchestrator/docs/API_reference.md b/Orchestrator/docs/API_reference.md deleted file mode 100644 index 49d3d8c929..0000000000 --- a/Orchestrator/docs/API_reference.md +++ /dev/null @@ -1,292 +0,0 @@ -# Orchestrator (PREVIEW2) - -## C# - -**OrchestratorRecognizer** - -```C# - /// - /// Class that represents an adaptive Orchestrator recognizer. - /// - public class OrchestratorRecognizer : IRecognizer - { - /// - /// Initializes a new instance of the class. - /// - [JsonConstructor] - public OrchestratorRecognizer() - { - } - - /// - /// Gets or sets the id for the recognizer. - /// - /// - /// The id for the recognizer. - /// - [JsonProperty("id")] - public string Id { get; set; } - - /// - /// Gets or sets the full path to the NLR model to use. - /// - /// - /// Model path. - /// - [JsonProperty("modelPath")] - public string ModelPath { get; set; } - - /// - /// Gets or sets the full path to the snapshot to use. - /// - /// - /// Snapshot path. - /// - [JsonProperty("snapshotPath")] - public string SnapshotPath { get; set; } - - /// - /// Gets or sets the entity recognizers. - /// - /// - /// The entity recognizers. - /// - [JsonProperty("entityRecognizers")] - public List EntityRecognizers { get; set; } = new List(); - - /// - /// Gets or sets the disambiguation score threshold. - /// - /// - /// Recognizer returns ChooseIntent (disambiguation) if other intents are classified within this score of the top scoring intent. - /// - [JsonProperty("disambiguationScoreThreshold")] - public float DisambiguationScoreThreshold { get; set; } = 0.05F; - - /// - /// Gets or sets a value indicating whether detect ambiguous intents. - /// - /// - /// When true, recognizer will look for ambiguous intents (intents with close recognition scores from top scoring intent). - /// - [JsonProperty("detectAmbiguousIntents")] - public bool DetectAmbiguousIntents { get; set; } = false; - - /// - public async Task RecognizeAsync(ITurnContext turnContext, CancellationToken cancellationToken); - } -``` - -**OrchestratorAdaptiveRecognizer** - -```C# -/// -/// Class that represents an adaptive Orchestrator recognizer. -/// -public class OrchestratorAdaptiveRecognizer : Recognizer -{ - /// - /// The Kind name for this recognizer. - /// - [JsonProperty("$kind")] - public const string Kind = "Microsoft.OrchestratorRecognizer"; - - /// - /// Property key in RecognizerResult that holds the full recognition result from Orchestrator core. - /// - public const string ResultProperty = "result"; - /// - /// Initializes a new instance of the class. - /// - /// Caller line. - /// Caller path. - [JsonConstructor] - public OrchestratorAdaptiveRecognizer([CallerFilePath] string callerPath = "", [CallerLineNumber] int callerLine = 0); - - /// - /// Initializes a new instance of the class. - /// - /// Path to NLR model. - /// Path to snapshot. - /// Label resolver. - public OrchestratorAdaptiveRecognizer(string modelPath, string snapshotPath, ILabelResolver resolver = null); - - /// - /// Gets or sets the full path to the NLR model to use. - /// - /// - /// Model path. - /// - [JsonProperty("modelPath")] - public StringExpression ModelPath { get; set; } = "=settings.orchestrator.modelPath"; - - /// - /// Gets or sets the full path to the snapshot to use. - /// - /// - /// Snapshot path. - /// - [JsonProperty("snapshotPath")] - public StringExpression SnapshotPath { get; set; } = "=settings.orchestrator.snapshotPath"; - - /// - /// Gets or sets the entity recognizers. - /// - /// - /// The entity recognizers. - /// - [JsonProperty("entityRecognizers")] - public List EntityRecognizers { get; set; } = new List(); - - /// - /// Gets or sets the disambiguation score threshold. - /// - /// - /// Recognizer returns ChooseIntent (disambiguation) if other intents are classified within this score of the top scoring intent. - /// - [JsonProperty("disambiguationScoreThreshold")] - public NumberExpression DisambiguationScoreThreshold { get; set; } = 0.05F; - - /// - /// Gets or sets detect ambiguous intents. - /// - /// - /// When true, recognizer will look for ambiguous intents (intents with close recognition scores from top scoring intent). - /// - [JsonProperty("detectAmbiguousIntents")] - public BoolExpression DetectAmbiguousIntents { get; set; } = false; - - /// - /// Return recognition results. - /// - /// Context object containing information for a single turn of conversation with a user. - /// The incoming activity received from the user. The Text property value is used as the query text for QnA Maker. - /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. - /// Additional properties to be logged to telemetry with the LuisResult event. - /// Additional metrics to be logged to telemetry with the LuisResult event. - /// A containing the QnA Maker result. - public override async Task RecognizeAsync(DialogContext dc, Schema.Activity activity, CancellationToken cancellationToken, Dictionary telemetryProperties = null, Dictionary telemetryMetrics = null); -} -``` - -## NodeJS - -**OrchestratorRecognizer** - -```JS -export class OrchestratorRecognizer extends Configurable { - /** - * Full recognition results are available under this property - */ - public readonly resultProperty: string = 'result'; - - /** - * Recognizers unique ID. - */ - public id: string; - - /** - * Path to the model to load. - */ - public modelPath: string = null; - - /** - * Path to the snapshot (.blu file) to load. - */ - public snapshotPath: string = null; - - /** - * The entity recognizers. - */ - public entityRecognizers: EntityRecognizer[] = []; - - /** - * Threshold value to use for ambiguous intent detection. Defaults to 0.05. - * Any intents that are classified with a score that is within this value from the top - * scoring intent is determined to be ambiguous. - */ - public disambiguationScoreThreshold: number = 0.05; - - /** - * Enable ambiguous intent detection. Defaults to false. - */ - public detectAmbiguousIntents: boolean = false; - - /** - * Returns recognition result. Also sends trace activity with recognition result. - * @param context Context for the current turn of conversation with the use. - */ - public async recognize(context: TurnContext): Promise {}} -``` - -**OrchestratorAdaptiveRecognizer** - -```JS -export class OrchestratorAdaptiveRecognizer extends Recognizer { - /** - * Recognizers unique ID. - */ - public id: string; - - /** - * Path to the model to load. - */ - public modelPath: StringExpression = new StringExpression(''); - - /** - * Path to the snapshot (.blu file) to load. - */ - public snapshotPath: StringExpression = new StringExpression(''); - - /** - * Threshold value to use for ambiguous intent detection. - * Any intents that are classified with a score that is within this value from the top scoring intent is determined to be ambiguous. - */ - public disambiguationScoreThreshold: NumberExpression = new NumberExpression(0.05); - - /** - * Enable ambiguous intent detection. - */ - public detectAmbiguousIntents: BoolExpression = new BoolExpression(false); - - /** - * The entity recognizers. - */ - public entityRecognizers: EntityRecognizer[] = []; - - /** - * Intent name if ambiguous intents are detected. - */ - public readonly chooseIntent: string = 'ChooseIntent'; - - /** - * Property under which ambiguous intents are returned. - */ - public readonly candidatesCollection: string = 'candidates'; - - /** - * Intent name when no intent matches. - */ - public readonly noneIntent: string = 'None'; - - /** - * Full recognition results are available under this property - */ - public readonly resultProperty: string = 'result'; - - /** - * Returns an OrchestratorAdaptiveRecognizer instance. - * @param modelPath Path to NLR model. - * @param snapshoPath Path to snapshot. - * @param resolver Orchestrator resolver to use. - */ - constructor(modelPath?: string, snapshoPath?: string, resolver?: any) {} - - /** - * Returns a new OrchestratorAdaptiveRecognizer instance. - * @param dialogContext Context for the current dialog. - * @param activity Current activity sent from user. - */ - public async recognize(dialogContext: DialogContext, activity: Activity): Promise {} -} -``` diff --git a/Orchestrator/docs/Overview.md b/Orchestrator/docs/Overview.md index 0535b97eef..e733b1110c 100644 --- a/Orchestrator/docs/Overview.md +++ b/Orchestrator/docs/Overview.md @@ -124,6 +124,6 @@ As we collect more feedback from the community during the preview there may be a [17]:https://en.wikipedia.org/wiki/TensorFlow [18]:https://en.wikipedia.org/wiki/Reinforcement_learning [19]:https://en.wikipedia.org/wiki/Precision_and_recall -[20]:./API_reference.md +[20]:https://docs.microsoft.com/en-us/dotnet/api/microsoft.bot.builder.ai.orchestrator?view=botbuilder-dotnet-stable