Skip to content

Commit 3c7364e

Browse files
author
apexvss@microsoft.com
committed
1 parent b512896 commit 3c7364e

25 files changed

+271
-172
lines changed

docs-ref-autogen/azure-core/azure.core.messaging.CloudEvent.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ constructor:
4040
- <xref:object>
4141
- name: time
4242
description: Optional. The time (in UTC) the event was generated.
43-
defaultValue: <object object at 0x000001A2C4FA08B0>
43+
defaultValue: <object object at 0x000001FF573A08B0>
4444
types:
4545
- <xref:datetime.datetime>
4646
- name: dataschema

docs-ref-autogen/azure-servicebus/azure.servicebus.aio.management.ServiceBusAdministrationClient.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ methods:
224224
keywordOnlyParameters:
225225
- name: filter
226226
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
227-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x000001D4CEB15810>
227+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x000001CA567D5A90>
228228
types:
229229
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
230230
<xref:azure.servicebus.management.SqlRuleFilter>]

docs-ref-autogen/azure-servicebus/azure.servicebus.management.ServiceBusAdministrationClient.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ methods:
233233
keywordOnlyParameters:
234234
- name: filter
235235
description: The filter of the rule. The default value is ~azure.servicebus.management.TrueRuleFilter
236-
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x000001D4CDCE11D0>
236+
defaultValue: <azure.servicebus.management._models.TrueRuleFilter object at 0x000001CA55991310>
237237
types:
238238
- <xref:typing.Union>[<xref:azure.servicebus.management.CorrelationRuleFilter>,
239239
<xref:azure.servicebus.management.SqlRuleFilter>]

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ fullName: azure.ai.evaluation.AzureAIProject
55
module: azure.ai.evaluation
66
inheritances:
77
- builtins.dict
8+
summary: Azure AI Project Information
89
constructor:
910
syntax: AzureAIProject()
1011
methods:
@@ -84,10 +85,13 @@ methods:
8485
attributes:
8586
- uid: azure.ai.evaluation.AzureAIProject.project_name
8687
name: project_name
88+
summary: Azure project name
8789
signature: 'project_name: str'
8890
- uid: azure.ai.evaluation.AzureAIProject.resource_group_name
8991
name: resource_group_name
92+
summary: Azure resource group name of the project
9093
signature: 'resource_group_name: str'
9194
- uid: azure.ai.evaluation.AzureAIProject.subscription_id
9295
name: subscription_id
96+
summary: Azure subscription id of the project
9397
signature: 'subscription_id: str'

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ fullName: azure.ai.evaluation.AzureOpenAIModelConfiguration
55
module: azure.ai.evaluation
66
inheritances:
77
- builtins.dict
8+
summary: Model Configuration for Azure OpenAI Model
89
constructor:
910
syntax: AzureOpenAIModelConfiguration()
1011
methods:
@@ -84,13 +85,21 @@ methods:
8485
attributes:
8586
- uid: azure.ai.evaluation.AzureOpenAIModelConfiguration.api_key
8687
name: api_key
88+
summary: API key of Azure OpenAI resource
8789
signature: 'api_key: str'
8890
- uid: azure.ai.evaluation.AzureOpenAIModelConfiguration.api_version
8991
name: api_version
92+
summary: (Optional) API version to use in request to Azure OpenAI deployment
9093
signature: 'api_version: str'
9194
- uid: azure.ai.evaluation.AzureOpenAIModelConfiguration.azure_deployment
9295
name: azure_deployment
96+
summary: Name of Azure OpenAI deployment to make request to
9397
signature: 'azure_deployment: str'
9498
- uid: azure.ai.evaluation.AzureOpenAIModelConfiguration.azure_endpoint
9599
name: azure_endpoint
100+
summary: Endpoint of Azure OpenAI resource to make request to
96101
signature: 'azure_endpoint: str'
102+
- uid: azure.ai.evaluation.AzureOpenAIModelConfiguration.type
103+
name: type
104+
summary: The type of the model configuration. Should be 'azure_openai' for AzureOpenAIModelConfiguration
105+
signature: 'type: Literal[''azure_openai'']'

preview/docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.ChatEvaluator.yml

Lines changed: 0 additions & 52 deletions
This file was deleted.

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: CoherenceEvaluator
44
fullName: azure.ai.evaluation.CoherenceEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_prompty_eval.PromptyEvaluatorBase
88
summary: "Initialize a coherence evaluator configured for a specific Azure OpenAI\
99
\ model.\n\n**Usage**\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
1010
: [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\"\
@@ -25,3 +25,16 @@ constructor:
2525
types:
2626
- <xref:typing.Union>[<xref:azure.ai.evaluation.AzureOpenAIModelConfiguration>,
2727
<xref:azure.ai.evaluation.OpenAIModelConfiguration>]
28+
attributes:
29+
- uid: azure.ai.evaluation.CoherenceEvaluator.DEFAULT_OPEN_API_VERSION
30+
name: DEFAULT_OPEN_API_VERSION
31+
signature: DEFAULT_OPEN_API_VERSION = '2024-02-15-preview'
32+
- uid: azure.ai.evaluation.CoherenceEvaluator.LLM_CALL_TIMEOUT
33+
name: LLM_CALL_TIMEOUT
34+
signature: LLM_CALL_TIMEOUT = 600
35+
- uid: azure.ai.evaluation.CoherenceEvaluator.PROMPTY_FILE
36+
name: PROMPTY_FILE
37+
signature: PROMPTY_FILE = 'coherence.prompty'
38+
- uid: azure.ai.evaluation.CoherenceEvaluator.RESULT_KEY
39+
name: RESULT_KEY
40+
signature: RESULT_KEY = 'gpt_coherence'

preview/docs-ref-autogen/azure-ai-evaluation/azure.ai.evaluation.ContentSafetyChatEvaluator.yml

Lines changed: 0 additions & 63 deletions
This file was deleted.
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
### YamlMime:PythonClass
2+
uid: azure.ai.evaluation.EvaluatorConfig
3+
name: EvaluatorConfig
4+
fullName: azure.ai.evaluation.EvaluatorConfig
5+
module: azure.ai.evaluation
6+
inheritances:
7+
- builtins.dict
8+
summary: Configuration for an evaluator
9+
constructor:
10+
syntax: EvaluatorConfig()
11+
methods:
12+
- uid: azure.ai.evaluation.EvaluatorConfig.clear
13+
name: clear
14+
signature: clear() -> None. Remove all items from D.
15+
- uid: azure.ai.evaluation.EvaluatorConfig.copy
16+
name: copy
17+
signature: copy() -> a shallow copy of D
18+
- uid: azure.ai.evaluation.EvaluatorConfig.fromkeys
19+
name: fromkeys
20+
summary: Create a new dictionary with keys from iterable and values set to value.
21+
signature: fromkeys(value=None, /)
22+
positionalOnlyParameters:
23+
- name: iterable
24+
isRequired: true
25+
- name: value
26+
defaultValue: None
27+
parameters:
28+
- name: type
29+
isRequired: true
30+
- uid: azure.ai.evaluation.EvaluatorConfig.get
31+
name: get
32+
summary: Return the value for key if key is in the dictionary, else default.
33+
signature: get(key, default=None, /)
34+
positionalOnlyParameters:
35+
- name: key
36+
isRequired: true
37+
- name: default
38+
defaultValue: None
39+
- uid: azure.ai.evaluation.EvaluatorConfig.items
40+
name: items
41+
signature: items() -> a set-like object providing a view on D's items
42+
- uid: azure.ai.evaluation.EvaluatorConfig.keys
43+
name: keys
44+
signature: keys() -> a set-like object providing a view on D's keys
45+
- uid: azure.ai.evaluation.EvaluatorConfig.pop
46+
name: pop
47+
summary: 'If the key is not found, return the default if given; otherwise,
48+
49+
raise a KeyError.'
50+
signature: pop(k, [d]) -> v, remove specified key and return the corresponding value.
51+
- uid: azure.ai.evaluation.EvaluatorConfig.popitem
52+
name: popitem
53+
summary: 'Remove and return a (key, value) pair as a 2-tuple.
54+
55+
56+
Pairs are returned in LIFO (last-in, first-out) order.
57+
58+
Raises KeyError if the dict is empty.'
59+
signature: popitem()
60+
- uid: azure.ai.evaluation.EvaluatorConfig.setdefault
61+
name: setdefault
62+
summary: 'Insert key with a value of default if key is not in the dictionary.
63+
64+
65+
Return the value for key if key is in the dictionary, else default.'
66+
signature: setdefault(key, default=None, /)
67+
positionalOnlyParameters:
68+
- name: key
69+
isRequired: true
70+
- name: default
71+
defaultValue: None
72+
- uid: azure.ai.evaluation.EvaluatorConfig.update
73+
name: update
74+
summary: 'If E is present and has a .keys() method, then does: for k in E: D[k]
75+
= E[k]
76+
77+
If E is present and lacks a .keys() method, then does: for k, v in E: D[k] =
78+
v
79+
80+
In either case, this is followed by: for k in F: D[k] = F[k]'
81+
signature: update([E], **F) -> None. Update D from dict/iterable E and F.
82+
- uid: azure.ai.evaluation.EvaluatorConfig.values
83+
name: values
84+
signature: values() -> an object providing a view on D's values
85+
attributes:
86+
- uid: azure.ai.evaluation.EvaluatorConfig.column_mapping
87+
name: column_mapping
88+
summary: Dictionary mapping evaluator input name to column in data
89+
signature: 'column_mapping: Dict[str, str]'

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ name: FluencyEvaluator
44
fullName: azure.ai.evaluation.FluencyEvaluator
55
module: azure.ai.evaluation
66
inheritances:
7-
- builtins.object
7+
- azure.ai.evaluation._evaluators._common._base_prompty_eval.PromptyEvaluatorBase
88
summary: "Initialize a fluency evaluator configured for a specific Azure OpenAI model.\n\
99
\n**Usage**\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [],\
1010
\ \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\": false,\
@@ -25,3 +25,16 @@ constructor:
2525
types:
2626
- <xref:typing.Union>[<xref:azure.ai.evaluation.AzureOpenAIModelConfiguration>,
2727
<xref:azure.ai.evaluation.OpenAIModelConfiguration>]
28+
attributes:
29+
- uid: azure.ai.evaluation.FluencyEvaluator.DEFAULT_OPEN_API_VERSION
30+
name: DEFAULT_OPEN_API_VERSION
31+
signature: DEFAULT_OPEN_API_VERSION = '2024-02-15-preview'
32+
- uid: azure.ai.evaluation.FluencyEvaluator.LLM_CALL_TIMEOUT
33+
name: LLM_CALL_TIMEOUT
34+
signature: LLM_CALL_TIMEOUT = 600
35+
- uid: azure.ai.evaluation.FluencyEvaluator.PROMPTY_FILE
36+
name: PROMPTY_FILE
37+
signature: PROMPTY_FILE = 'fluency.prompty'
38+
- uid: azure.ai.evaluation.FluencyEvaluator.RESULT_KEY
39+
name: RESULT_KEY
40+
signature: RESULT_KEY = 'gpt_fluency'

0 commit comments

Comments
 (0)