Skip to content

Commit af518f3

Browse files
docsreference@microsoft.comnickwalkmsft
docsreference@microsoft.com
authored andcommitted
CI Update
Build.Reason:Manual by Nick Walker (MS Learn) Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=496039&view=results
1 parent e5d1874 commit af518f3

File tree

30,422 files changed

+273769
-2528996
lines changed

Some content is hidden

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

30,422 files changed

+273769
-2528996
lines changed

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.AzureAIProject.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ examples:
2828
- "Creating an AzureAIProject object.<!--[!code-python[Main](les\\evaluation_samples_common.py\
2929
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
3030
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
31-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
31+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
3232
\\samples\\\\evaluation_samples_common.py\", \"xml:space\": \"preserve\", \"force\"\
3333
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
3434
linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation._model_configurations\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.AzureOpenAIModelConfiguration.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ examples:
4040
evaluation_samples_common.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
4141
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
4242
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
43-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_common.py\", \"\
43+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_common.py\", \"\
4444
xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
4545
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation._model_configurations\
4646
\ import AzureOpenAIModelConfiguration\n\n model_config = AzureOpenAIModelConfiguration(\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.BleuScoreEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: BleuScoreEvaluator
44
fullName: azure.ai.evaluation.BleuScoreEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_eval.EvaluatorBase
88
summary: 'Calculate the BLEU score for a given response and ground truth.
99
1010
@@ -30,7 +30,7 @@ examples:
3030
- "Initialize and call an BleuScoreEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
3131
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
3232
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
33-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
33+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
3434
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
3535
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
3636
linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation import BleuScoreEvaluator\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.CoherenceEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ examples:
4848
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
4949
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
5050
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
51-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
51+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
5252
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
5353
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
5454
\ from azure.ai.evaluation import CoherenceEvaluator\n\n model_config = {\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.ContentSafetyEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: ContentSafetyEvaluator
44
fullName: azure.ai.evaluation.ContentSafetyEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- azure.ai.evaluation._evaluators._common._base_eval.EvaluatorBase
7+
- azure.ai.evaluation._evaluators._common._base_multi_eval.MultiEvaluatorBase
88
summary: '> [!NOTE]
99
1010
> This is an experimental class, and may change at any time. Please see [https://aka.ms/azuremlexperimental](https://aka.ms/azuremlexperimental)
@@ -39,7 +39,7 @@ examples:
3939
- "Initialize and call a ContentSafetyEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
4040
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
4141
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
42-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
42+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
4343
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
4444
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
4545
linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.F1ScoreEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: F1ScoreEvaluator
44
fullName: azure.ai.evaluation.F1ScoreEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_eval.EvaluatorBase
88
summary: 'Calculates the F1 score for a given response and ground truth or a multi-turn
99
conversation.
1010
@@ -41,7 +41,7 @@ examples:
4141
- "Initialize and call an F1ScoreEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
4242
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
4343
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
44-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
44+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
4545
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
4646
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
4747
linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation import F1ScoreEvaluator\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.FluencyEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ examples:
4949
- "Initialize and call a FluencyEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
5050
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
5151
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
52-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
52+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
5353
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
5454
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
5555
linenos\": false} -->\n\n````python\n\n import os\n from azure.ai.evaluation\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.GleuScoreEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: GleuScoreEvaluator
44
fullName: azure.ai.evaluation.GleuScoreEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_eval.EvaluatorBase
88
summary: 'Calculates the GLEU (Google-BLEU) score between a response and the ground
99
truth.
1010
@@ -31,7 +31,7 @@ examples:
3131
- "Initialize and call a GleuScoreEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
3232
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
3333
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
34-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
34+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
3535
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
3636
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
3737
linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation import GleuScoreEvaluator\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.GroundednessEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ examples:
5959
- "Initialize and call a GroundednessEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
6060
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
6161
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
62-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
62+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
6363
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
6464
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
6565
linenos\": false} -->\n\n````python\n\n import os\n from azure.ai.evaluation\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.GroundednessProEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ examples:
6767
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
6868
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
6969
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
70-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
70+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
7171
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
7272
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
7373
\ from azure.identity import DefaultAzureCredential\n from azure.ai.evaluation\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.HateUnfairnessEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ examples:
5151
- "Initialize and call a HateUnfairnessEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
5252
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
5353
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
54-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
54+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
5555
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
5656
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
5757
linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.IndirectAttackEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ examples:
4949
- "Initialize and call an IndirectAttackEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
5050
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
5151
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
52-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
52+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
5353
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
5454
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
5555
linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.MeteorScoreEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: MeteorScoreEvaluator
44
fullName: azure.ai.evaluation.MeteorScoreEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_eval.EvaluatorBase
88
summary: 'Calculates the METEOR score for a given response and ground truth.
99
1010
@@ -57,7 +57,7 @@ examples:
5757
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
5858
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
5959
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
60-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
60+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
6161
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
6262
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation\
6363
\ import MeteorScoreEvaluator\n\n meteor_evaluator = MeteorScoreEvaluator(alpha=0.8)\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.OpenAIModelConfiguration.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ examples:
3838
- "Creating an OpenAIModelConfiguration object.<!--[!code-python[Main](les\\evaluation_samples_common.py\
3939
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
4040
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
41-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
41+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
4242
\\samples\\\\evaluation_samples_common.py\", \"xml:space\": \"preserve\", \"force\"\
4343
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
4444
linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation._model_configurations\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.ProtectedMaterialEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ examples:
4848
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
4949
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
5050
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
51-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
51+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
5252
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
5353
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
5454
\ from azure.identity import DefaultAzureCredential\n from azure.ai.evaluation\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.QAEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: QAEvaluator
44
fullName: azure.ai.evaluation.QAEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_multi_eval.MultiEvaluatorBase
88
summary: 'Initialize a question-answer evaluator configured for a specific Azure OpenAI
99
model.
1010
@@ -43,7 +43,7 @@ examples:
4343
- "Initialize and call a QAEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
4444
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
4545
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
46-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
46+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
4747
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
4848
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
4949
linenos\": false} -->\n\n````python\n\n import os\n from azure.ai.evaluation\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.RelevanceEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ examples:
6060
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
6161
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
6262
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
63-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
63+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
6464
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
6565
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n import os\n\
6666
\ from azure.ai.evaluation import RelevanceEvaluator\n\n model_config = {\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.RetrievalEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ examples:
6060
- "Initialize and call a RetrievalEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
6161
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
6262
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
63-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
63+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
6464
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
6565
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
6666
linenos\": false} -->\n\n````python\n\n import os\n from azure.ai.evaluation\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.RougeScoreEvaluator.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: RougeScoreEvaluator
44
fullName: azure.ai.evaluation.RougeScoreEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_eval.EvaluatorBase
88
summary: 'Calculates the ROUGE score for a given response and ground truth.
99
1010
@@ -46,7 +46,7 @@ examples:
4646
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
4747
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
4848
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
49-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
49+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
5050
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
5151
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation\
5252
\ import RougeScoreEvaluator, RougeType\n\n rouge_evaluator = RougeScoreEvaluator(rouge_type=RougeType.ROUGE_4)\n\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.SelfHarmEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ examples:
4242
- "Initialize and call a SelfHarmEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
4343
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
4444
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
45-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
45+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
4646
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
4747
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
4848
linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.SexualEvaluator.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ examples:
4646
- "Initialize and call a SexualEvaluator.<!--[!code-python[Main](les\\evaluation_samples_evaluate.py\
4747
\ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
4848
: [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
49-
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\5\\\\azure_ai_evaluation-1.1.0\\\
49+
\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\4\\\\azure_ai_evaluation-1.2.0\\\
5050
\\samples\\\\evaluation_samples_evaluate.py\", \"xml:space\": \"preserve\", \"force\"\
5151
: false, \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"\
5252
linenos\": false} -->\n\n````python\n\n import os\n from azure.identity import\

docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.SimilarityEvaluator.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: SimilarityEvaluator
44
fullName: azure.ai.evaluation.SimilarityEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_prompty_eval.PromptyEvaluatorBase
88
summary: 'Evaluates similarity score for a given query, response, and ground truth.
99
1010
@@ -64,7 +64,7 @@ examples:
6464
evaluation_samples_evaluate.py )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\"\
6565
: [], \"names\": [], \"dupnames\": [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\
6666
\\windows\\\\Python\\\\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\
67-
\\5\\\\azure_ai_evaluation-1.1.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
67+
\\4\\\\azure_ai_evaluation-1.2.0\\\\samples\\\\evaluation_samples_evaluate.py\"\
6868
, \"xml:space\": \"preserve\", \"force\": false, \"language\": \"python\", \"highlight_args\"\
6969
: {\"linenostart\": 1}, \"linenos\": false} -->\n\n````python\n\n from azure.ai.evaluation\
7070
\ import RougeScoreEvaluator, RougeType\n\n rouge_evaluator = RougeScoreEvaluator(rouge_type=RougeType.ROUGE_4)\n\
@@ -75,4 +75,4 @@ attributes:
7575
name: id
7676
summary: Evaluator identifier, experimental and to be used only with evaluation
7777
in cloud.
78-
signature: id = 'azureml://registries/azureml/models/Similarity-Evaluator/versions/3'
78+
signature: id = 'similarity'

0 commit comments

Comments
 (0)