Skip to content

Commit 5017465

Browse files
chrimc62chrimc62
authored
Add schemas from C# to packages. (#2986) (#2987)
1 parent dad64d4 commit 5017465

File tree

202 files changed

+5363
-24
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+5363
-24
lines changed

‎libraries/botbuilder-ai-orchestrator/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
},
4848
"files": [
4949
"lib",
50-
"schema",
50+
"schemas",
5151
"src"
5252
]
5353
}

‎libraries/botbuilder-ai-orchestrator/schema/Microsoft.OrchestratorRecognizer.schema renamed to ‎libraries/botbuilder-ai-orchestrator/schemas/Microsoft.OrchestratorRecognizer.schema

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
33
"$role": "implements(Microsoft.IRecognizer)",
4-
"title": "QnAMaker Recognizer",
5-
"description": "Recognizer for generating QnAMatch intents from a KB.",
4+
"title": "Orchestrator recognizer",
5+
"description": "Orchestrator recognizer.",
66
"type": "object",
77
"properties": {
88
"id": {
@@ -14,23 +14,13 @@
1414
"$ref": "schema:#/definitions/stringExpression",
1515
"title": "Model",
1616
"description": "NLR model file path.",
17-
"default": "settings.orchestrator.modelpath"
17+
"default": "=settings.orchestrator.modelpath"
1818
},
1919
"snapshotPath": {
2020
"$ref": "schema:#/definitions/stringExpression",
21-
"title": "Endpoint Key",
21+
"title": "Endpoint key",
2222
"description": "SnapShot file path.",
23-
"default": "settings.orchestrator.shapshotpath"
24-
},
25-
"useCompactEmbeddings": {
26-
"$ref": "schema:#/definitions/booleanExpression",
27-
"title": "Use compact embeddings",
28-
"description": "If true, compact embeddings will be used.",
29-
"default": "true",
30-
"examples": [
31-
true,
32-
"=turn.useCompactEmbeddings"
33-
]
23+
"default": "=settings.orchestrator.shapshotpath"
3424
},
3525
"entityRecognizers": {
3626
"type": "array",
@@ -46,20 +36,20 @@
4636
"description": "Recognizer returns ChooseIntent (disambiguation) if other intents are classified within this score of the top scoring intent.",
4737
"default": 0.05,
4838
"examples": [
49-
true,
39+
"=true",
5040
"=turn.scoreThreshold",
51-
"=settings.orchestrator.disambigscorethreshold"
41+
"=settings.orchestrator.disambigScoreThreshold"
5242
]
5343
},
5444
"detectAmbiguousIntents": {
5545
"$ref": "schema:#/definitions/booleanExpression",
56-
"title": "Threshold",
46+
"title": "Detect ambiguous intents",
5747
"description": "If true, recognizer will look for ambiguous intents (intents with close recognition scores from top scoring intent).",
5848
"default": false,
5949
"examples": [
60-
true,
50+
"=true",
6151
"=turn.detectAmbiguousIntents",
62-
"=settings.orchestrator.detectambiguousintents"
52+
"=settings.orchestrator.detectAmbiguousIntents"
6353
]
6454
}
6555
},

‎libraries/botbuilder-ai/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@
5555
},
5656
"files": [
5757
"lib",
58+
"schemas",
5859
"src"
5960
]
6061
}

‎libraries/botbuilder-ai/schemas/Microsoft.LuisRecognizer.schema

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
{
2+
"$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
3+
"$role": "implements(Microsoft.IRecognizer)",
4+
"title": "LUIS Recognizer",
5+
"description": "LUIS recognizer.",
6+
"type": "object",
7+
"additionalProperties": false,
8+
"properties": {
9+
"id": {
10+
"type": "string",
11+
"title": "Id",
12+
"description": "Optional unique id using with RecognizerSet. Other recognizers should return 'DeferToRecognizer_{Id}' intent when cross training data for this recognizer."
13+
},
14+
"applicationId": {
15+
"$ref": "schema:#/definitions/stringExpression",
16+
"title": "LUIS application id",
17+
"description": "Application ID for your model from the LUIS service."
18+
},
19+
"version": {
20+
"$ref": "schema:#/definitions/stringExpression",
21+
"title": "LUIS version",
22+
"description": "Optional version to target. If null then predictionOptions.Slot is used."
23+
},
24+
"endpoint": {
25+
"$ref": "schema:#/definitions/stringExpression",
26+
"title": "LUIS endpoint",
27+
"description": "Endpoint to use for LUIS service like https://westus.api.cognitive.microsoft.com."
28+
},
29+
"endpointKey": {
30+
"$ref": "schema:#/definitions/stringExpression",
31+
"title": "LUIS prediction key",
32+
"description": "LUIS prediction key used to call endpoint."
33+
},
34+
"externalEntityRecognizer": {
35+
"$kind": "Microsoft.IRecognizer",
36+
"title": "External entity recognizer",
37+
"description": "Entities recognized by this recognizer will be passed to LUIS as external entities."
38+
},
39+
"dynamicLists": {
40+
"$ref": "schema:#/definitions/arrayExpression",
41+
"title": "Dynamic lists",
42+
"description": "Runtime defined entity lists.",
43+
"items": {
44+
"title": "Entity list",
45+
"description": "Lists of canonical values and synonyms for an entity.",
46+
"type": "object",
47+
"properties": {
48+
"entity": {
49+
"title": "Entity",
50+
"description": "Entity to extend with a dynamic list.",
51+
"type": "string"
52+
},
53+
"list": {
54+
"title": "Dynamic list",
55+
"description": "List of canonical forms and synonyms.",
56+
"type": "array",
57+
"items": {
58+
"type": "object",
59+
"title": "List entry",
60+
"description": "Canonical form and synonynms.",
61+
"properties": {
62+
"canonicalForm": {
63+
"title": "Canonical form",
64+
"description": "Resolution if any synonym matches.",
65+
"type": "string"
66+
},
67+
"synonyms": {
68+
"title": "Synonyms",
69+
"description": "List of synonyms for a canonical form.",
70+
"type": "array",
71+
"items": {
72+
"title": "Synonym",
73+
"description": "Synonym for canonical form.",
74+
"type": "string"
75+
}
76+
}
77+
}
78+
}
79+
}
80+
}
81+
}
82+
},
83+
"predictionOptions": {
84+
"type": "object",
85+
"title": "Prediction options",
86+
"description": "Options to control LUIS prediction behavior.",
87+
"properties": {
88+
"includeAllIntents": {
89+
"$ref": "schema:#/definitions/booleanExpression",
90+
"title": "Include all intents",
91+
"description": "True for all intents, false for only top intent."
92+
},
93+
"includeInstanceData": {
94+
"$ref": "schema:#/definitions/booleanExpression",
95+
"title": "Include $instance",
96+
"description": "True to include $instance metadata in the LUIS response."
97+
},
98+
"log": {
99+
"$ref": "schema:#/definitions/booleanExpression",
100+
"title": "Log utterances",
101+
"description": "True to log utterances on LUIS service."
102+
},
103+
"preferExternalEntities": {
104+
"$ref": "schema:#/definitions/booleanExpression",
105+
"title": "Prefer external entities",
106+
"description": "True to prefer external entities to those generated by LUIS models."
107+
},
108+
"slot": {
109+
"$ref": "schema:#/definitions/stringExpression",
110+
"title": "Slot",
111+
"description": "Slot to use for talking to LUIS service like production or staging."
112+
}
113+
}
114+
}
115+
},
116+
"required": [
117+
"applicationId",
118+
"endpoint",
119+
"endpointKey"
120+
]
121+
}

‎libraries/botbuilder-ai/schemas/Microsoft.QnAMakerDialog.schema

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
{
2+
"$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
3+
"$role": "implements(Microsoft.IDialog)",
4+
"title": "QnAMaker dialog",
5+
"description": "Dialog which uses QnAMAker knowledge base to answer questions.",
6+
"type": "object",
7+
"additionalProperties": false,
8+
"properties": {
9+
"knowledgeBaseId": {
10+
"$ref": "schema:#/definitions/stringExpression",
11+
"title": "KnowledgeBase Id",
12+
"description": "KnowledgeBase Id of your QnA Maker KnowledgeBase.",
13+
"default": "=settings.qna.knowledgebaseid"
14+
},
15+
"endpointKey": {
16+
"$ref": "schema:#/definitions/stringExpression",
17+
"title": "Endpoint key",
18+
"description": "Endpoint key for the QnA Maker KB.",
19+
"default": "=settings.qna.endpointkey"
20+
},
21+
"hostname": {
22+
"$ref": "schema:#/definitions/stringExpression",
23+
"title": "Hostname",
24+
"description": "Hostname for your QnA Maker service.",
25+
"default": "=settings.qna.hostname",
26+
"examples": [
27+
"https://yourserver.azurewebsites.net/qnamaker"
28+
]
29+
},
30+
"noAnswer": {
31+
"$kind": "Microsoft.IActivityTemplate",
32+
"title": "Fallback answer",
33+
"description": "Default answer to return when none found in KB.",
34+
"default": "Sorry, I did not find an answer."
35+
},
36+
"threshold": {
37+
"$ref": "schema:#/definitions/numberExpression",
38+
"title": "Threshold",
39+
"description": "Threshold score to filter results.",
40+
"default": 0.3
41+
},
42+
"activeLearningCardTitle": {
43+
"$ref": "schema:#/definitions/stringExpression",
44+
"title": "Active learning card title",
45+
"description": "Title for active learning suggestions card.",
46+
"default": "Did you mean:"
47+
},
48+
"cardNoMatchText": {
49+
"$ref": "schema:#/definitions/stringExpression",
50+
"title": "Card no match text",
51+
"description": "Text for no match option.",
52+
"default": "None of the above."
53+
},
54+
"cardNoMatchResponse": {
55+
"$kind": "Microsoft.IActivityTemplate",
56+
"title": "Card no match response",
57+
"description": "Custom response when no match option was selected.",
58+
"default": "Thanks for the feedback."
59+
},
60+
"strictFilters": {
61+
"$ref": "schema:#/definitions/arrayExpression",
62+
"title": "Strict filters",
63+
"description": "Metadata filters to use when calling the QnA Maker KB.",
64+
"items": {
65+
"type": "object",
66+
"title": "Metadata filter",
67+
"description": "Metadata filter.",
68+
"properties": {
69+
"name": {
70+
"type": "string",
71+
"title": "Name",
72+
"description": "Name of filter property.",
73+
"maximum": 100
74+
},
75+
"value": {
76+
"type": "string",
77+
"title": "Value",
78+
"description": "Value to filter on.",
79+
"maximum": 100
80+
}
81+
}
82+
}
83+
},
84+
"top": {
85+
"$ref": "schema:#/definitions/numberExpression",
86+
"title": "Top",
87+
"description": "The number of answers you want to retrieve.",
88+
"default": 3
89+
},
90+
"isTest": {
91+
"type": "boolean",
92+
"title": "IsTest",
93+
"description": "True, if pointing to Test environment, else false.",
94+
"default": false
95+
},
96+
"rankerType": {
97+
"$ref": "schema:#/definitions/stringExpression",
98+
"title": "Ranker type",
99+
"description": "Type of Ranker.",
100+
"oneOf": [
101+
{
102+
"title": "Standard ranker",
103+
"description": "Standard ranker types.",
104+
"enum": [
105+
"default",
106+
"questionOnly",
107+
"autoSuggestQuestion"
108+
],
109+
"default": "default"
110+
},
111+
{
112+
"$ref": "schema:#/definitions/equalsExpression"
113+
}
114+
]
115+
},
116+
"strictFiltersJoinOperator": {
117+
"$ref": "schema:#/definitions/stringExpression",
118+
"title": "StrictFiltersJoinOperator",
119+
"description": "Join operator for Strict Filters.",
120+
"oneOf": [
121+
{
122+
"title": "Join operator",
123+
"description": "Value of Join Operator to be used as conjunction with Strict Filter values.",
124+
"enum": [
125+
"AND",
126+
"OR"
127+
],
128+
"default": "AND"
129+
},
130+
{
131+
"$ref": "schema:#/definitions/equalsExpression"
132+
}
133+
]
134+
}
135+
},
136+
"required": [
137+
"knowledgeBaseId",
138+
"endpointKey",
139+
"hostname"
140+
]
141+
}

0 commit comments

Comments
 (0)