You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/decisions/0042-samples-restructure.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ samples/
70
70
Pros:
71
71
72
72
- Simpler and Less verbose structure (Worse is Better: Less is more approach)
73
-
-Beginers will be presented (sibling folders) to other tutorials that may fit better on their need and use case.
73
+
-Beginners will be presented (sibling folders) to other tutorials that may fit better on their need and use case.
74
74
- Getting started will not be imposed.
75
75
76
76
Cons:
@@ -101,7 +101,7 @@ Pros:
101
101
102
102
Cons:
103
103
104
-
- If the Getting starded example does not have a valid example for the customer it has go back on other folders for more content.
104
+
- If the Getting started example does not have a valid example for the customer it has go back on other folders for more content.
105
105
106
106
### Option 3 - Conservative + Use Cases Based Root Categorization
107
107
@@ -130,7 +130,7 @@ Cons:
130
130
- More verbose structure adds extra friction to find the samples.
131
131
-`KernelContent` or `Modalities` is a internal term that may not be clear for the customer
132
132
-`Documentation` may be confused a documents only folder, which actually contains code samples used in documentation. (not clear message)
133
-
-`Use Cases` may suggest an idea of real world use cases implemented, where in reality those are simple demostrations of a SK feature.
133
+
-`Use Cases` may suggest an idea of real world use cases implemented, where in reality those are simple demonstrations of a SK feature.
134
134
135
135
## KernelSyntaxExamples Decomposition Options
136
136
@@ -449,7 +449,7 @@ Cons:
449
449
450
450
### KernelSyntaxExamples Decomposition Option 2 - Concept by Components Flattened Version
451
451
452
-
Similar approach to Option 1, but with a flattened structure using a single level of folders to avoid deep nesting and complexity authough keeping easy to navigate around the componentized concepts.
452
+
Similar approach to Option 1, but with a flattened structure using a single level of folders to avoid deep nesting and complexity although keeping easy to navigate around the componentized concepts.
Copy file name to clipboardExpand all lines: docs/decisions/0046-java-repository-separation.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Also managing repository policies that are preferred by all languages is a chall
27
27
complex build process to account for building multiple languages. If a user makes accidental changes to the repository outside their own language,
28
28
or make changes to the common files, require sign off from other languages, leading to delays as we
29
29
require review from users in other languages. Similarly common files such as GitHub Actions workflows, `.gitignore`, VS Code settings, `README.md`, `.editorconfig` etc, become
30
-
more complex as they have to simutaniously support multiple languages.
30
+
more complex as they have to simultaneously support multiple languages.
31
31
32
32
In a community point of view, having a separate repo will foster community engagement, allowing developers to contribute, share ideas, and collaborate on the Java projects only.
33
33
Additionally, it enables transparent tracking of contributions, making it easy to identify top contributors and acknowledge their efforts.
Copy file name to clipboardExpand all lines: docs/decisions/0047-azure-open-ai-connectors.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ A documentation guidance and samples/examples will be created to guide on how to
37
37
38
38
## OpenAI SDK limitations
39
39
40
-
The new OpenAI SDK introduce some limitations that need to be considered and pontentially can introduce breaking changes if not remediated by our internal implementation.
40
+
The new OpenAI SDK introduce some limitations that need to be considered and potentially can introduce breaking changes if not remediated by our internal implementation.
41
41
42
42
-#### ⚠️ No support for multiple results (Choices) per request.
Copy file name to clipboardExpand all lines: docs/decisions/0049-agents-assistantsV2.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -154,9 +154,9 @@ A pending change has been authored that introduces `FunctionChoiceBehavior` as a
154
154
155
155
#### Assistant Invocation Options
156
156
157
-
When invoking an `OpenAIAssistantAgent` directly (no-chat), definition that only apply to a discrete run may be specified. These definition are defined as `OpenAIAssistantInvocationOptions` and ovetake precedence over any corresponding assistant or thread definition.
157
+
When invoking an `OpenAIAssistantAgent` directly (no-chat), definition that only apply to a discrete run may be specified. These definition are defined as `OpenAIAssistantInvocationOptions` and overtake precedence over any corresponding assistant or thread definition.
158
158
159
-
> Note: These definition are also impacted by the `ToolCallBehavior` / `FunctionChoiceBehavior`quadary.
159
+
> Note: These definition are also impacted by the `ToolCallBehavior` / `FunctionChoiceBehavior`quandary.
Copy file name to clipboardExpand all lines: docs/decisions/0050-updated-vector-store-design.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -113,7 +113,7 @@ classDiagram
113
113
class IVectorRecordStore~TModel~{
114
114
<<interface>>
115
115
+Upsert(TModel record) string
116
-
+UpserBatch(TModel record) string
116
+
+UpsertBatch(TModel record) string
117
117
+Get(string key) TModel
118
118
+GetBatch(string[] keys) TModel[]
119
119
+Delete(string key)
@@ -619,7 +619,7 @@ Option 1 is problematic on its own, since we have to allow consumers to create c
619
619
a single interface like this, it will require them to implement many methods that they do not want to change. Options 4 & 5, gives us more flexibility while
620
620
still preserving the ease of use of an aggregated interface as described in Option 1.
621
621
622
-
Option 2 doesn't give us the flexbility we need for break glass scenarios, since it only allows certain types of collections to be created. It also means
622
+
Option 2 doesn't give us the flexibility we need for break glass scenarios, since it only allows certain types of collections to be created. It also means
623
623
that each time a new collection type is required it introduces a breaking change, so it is not a viable option.
624
624
625
625
Since collection create and configuration and the possible options vary considerable across different database types, we will need to support an easy
Copy file name to clipboardExpand all lines: docs/decisions/0061-function-call-behavior.md
+2-3
Original file line number
Diff line number
Diff line change
@@ -242,8 +242,7 @@ More details can be found here: [Serialize polymorphic types](https://learn.micr
242
242
To support custom function choice behaviors, the custom types should be registered for polymorphic deserialization.
243
243
Clearly, the approach using the JsonDerivedType attribute is not viable, as users cannot annotate `FunctionChoiceBehavior` SK class.
244
244
However, they could register their custom type resolver that would register their custom type(s) if they had access to JsonSerializerOptions used by JsonSerializer during deserialization.
245
-
Unfortunately, SK does not expose those options publicly today. Even if it had, there are YAML prompts that are deserialized by the YamlDotNet library that would require same custom types s
246
-
upplied via YAML specific deserializer extensibility mechanisms - YamlTypeConverter.
245
+
Unfortunately, SK does not expose those options publicly today. Even if it had, there are YAML prompts that are deserialized by the YamlDotNet library that would require same custom types supplied via YAML specific deserializer extensibility mechanisms - YamlTypeConverter.
247
246
This would mean that if a user wants the same custom function calling choice to be used in both YAML and JSON prompts, they would have to register the same custom type twice - for JSON
248
247
via a custom type resolver and for YAML via a custom YamlTypeConverter. That would also require a mechanism of supplying custom resolvers/converters to all SK `CreateFunctionFrom*Prompt` extension methods.
249
248
@@ -378,4 +377,4 @@ There were a few decisions taken during the ADR review:
378
377
- Option 1.1 was chosen as the preferred option for the new function call behavior model.
379
378
- It was decided to postpone the implementation of the inheritance mechanism that allows a service to inherit the parent function choice behavior configuration.
380
379
- It was decided that the Breaking Glass support is out of scope for now, but it may be included later if necessary.
381
-
- Option 2.5, which presumes supplying function call choices and function invocation configurations via prompt execution settings, was preferred over the other options due to its simplicity, absence of breaking changes, and familiar developer experience.
380
+
- Option 2.5, which presumes supplying function call choices and function invocation configurations via prompt execution settings, was preferred over the other options due to its simplicity, absence of breaking changes, and familiar developer experience.
0 commit comments