Skip to content

Commit

Permalink
Merge pull request #1760 from solliancenet/cj-conversation-resource-p…
Browse files Browse the repository at this point in the history
…rovider-082

(0.8.2) FoundationaLLM.Conversation resource provider
  • Loading branch information
kylebunting authored Sep 22, 2024
2 parents eb76167 + e260e6b commit b4acdd9
Show file tree
Hide file tree
Showing 161 changed files with 3,172 additions and 3,104 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"type": "multipart",
"name": "FoundationaLLM",
"object_id": "/instances/${env:FOUNDATIONALLM_INSTANCE_ID}/providers/FoundationaLLM.Prompt/prompts/FoundationaLLM",
"description": "Describes the persona and context for the FoundationaLLM agent, useful for answering questions about FoundationaLLM (FLLM).",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"type": "multipart",
"name": "FoundationaLLM",
"object_id": "/instances/{{instanceId}}/providers/FoundationaLLM.Prompt/prompts/FoundationaLLM",
"description": "Describes the persona and context for the FoundationaLLM agent, useful for answering questions about FoundationaLLM (FLLM).",
Expand Down
44 changes: 38 additions & 6 deletions docs/release-notes/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,41 @@
> [!NOTE]
> This section is for changes that are not yet released but will affect future releases.
## Breaking changes that will affect future releases
## Starting with 0.8.2

### Starting with 0.8.0
### Configuration changes

The following settings are required:

Name | Default value
--- | ---
`FoundationaLLM:APIEndpoints:CoreAPI:Configuration:AllowedUploadFileExtensions` | `c, cpp, cs, css, csv, doc, docx, git, html, java, jpeg, jpg, js, json, md, pdf, php, png, pptx, py, rb, sh, tar, tex, ts, txt, xlsx, xml, zip`
`FoundationaLLM:APIEndpoints:CoreAPI:Configuration:AzureOpenAIAssistantsFileSearchFileExtensions` | `c, cpp, cs, css, doc, docx, html, java, js, json, md, pdf, php, pptx, py, rb, sh, tex, ts, txt`

The following settings are optional (they should not be set by default):

Name | Default value
--- | ---
`FoundationaLLM:Instance:IdentitySubstitutionSecurityPrincipalId` | <security_principal_id>
`FoundationaLLM:Instance:IdentitySubstitutionUserPrincipalNamePattern` | `^fllm_load_test_user_\d{5}_\d{3}@solliance\.net$`

>[!NOTE]
> The `FoundationaLLM:Instance:IdentitySubstitutionSecurityPrincipalId` and `FoundationaLLM:Instance:IdentitySubstitutionUserPrincipalNamePattern` settings are used for load testing purposes only. If set, their values must be replaced with the appropriate values for the specific Entra ID tenant.
### Resource provider changes

The following resource provider files must be renamed (if they already exist):

Location | Old name | New name
--- | --- | ---
`resource-provider/FoundationaLLM.Agent` | `_agent-references.json` | `_resource-references.json`
`resource-provider/FoundationaLLM.AIModel` | `_ai-model-references.json` | `_resource-references.json`
`resource-provider/FoundationaLLM.Configuration` | `_api-endpoint-references.json` | `_resource-references.json`
`resource-provider/FoundationaLLM.DataSource` | `_data-source-references.json` | `_resource-references.json`
`resource-provider/FoundationaLLM.Prompt` | `_prompt-references.json` | `_resource-references.json`


## Starting with 0.8.0

Core API changes:

Expand All @@ -31,7 +63,7 @@ Orchestration API changes:
1. All Gatekeeper API endpoints have been moved to the `/instances/{instanceId}` path. For example, the `/status` endpoint is now `/instances/{instanceId}/status`.
2. The `/orchestration/*` endpoints have been moved to `/instances/{instanceId}/completions/*`.
=======
#### New APIs
### New APIs

**Gateway Adapter API** - requires the following configuration settings:

Expand All @@ -48,7 +80,7 @@ Orchestration API changes:
> [!NOTE]
> These new APIs will be converted to use the new `APIEndpoint` artifacts.
#### Changes in app registration names
### Changes in app registration names

API Name | Entra ID app registration name | Application ID URI | Scope name
--- | --- | --- | ---
Expand All @@ -58,7 +90,7 @@ Authorization API | `FoundationaLLM-Authorization-API` | `api://FoundationaLLM-A
User Portal | `FoundationaLLM-Core-Portal` | `api://FoundationaLLM-Core-Portal` | N/A
Management Portal | `FoundationaLLM-Management-Portal` | `api://FoundationaLLM-Management-Portal` | N/A

#### Changes in app configuration settings
### Changes in app configuration settings

The `FoundationaLLM:APIs` and `FoundationaLLM:ExternalAPIs` configuration namespaces have been replaced with the `FoundationaLLM:APIEndpoints` configuration namespace.

Expand All @@ -76,7 +108,7 @@ Two new configuration settings required by the new `FoundationaLLM.AzureOpenAI`
- `FoundationaLLM:ResourceProviders:AzureOpenAI:Storage:AuthenticationType`
- `FoundationaLLM:ResourceProviders:AzureOpenAI:Storage:AccountName`

### Pre-0.8.0
## Pre-0.8.0

1. Vectorization resource stores use a unique collection name, `Resources`. They also add a new top-level property named `DefaultResourceName`.
2. The items in the `index_references` collection have a property incorrectly named `type` which was renamed to `index_entry_id`.
Expand Down
9 changes: 8 additions & 1 deletion src/FoundationaLLM.sln
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AzureOpenAI", "dotnet\Azure
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{B9ABEB53-19C8-4224-8820-CF2D82DCC559}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Core.Examples.LoadTests", "..\tests\dotnet\Core.Examples.LoadTests\Core.Examples.LoadTests.csproj", "{ABA2F0F5-6372-4D7A-9B97-E1089C988B59}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Core.Examples.LoadTests", "..\tests\dotnet\Core.Examples.LoadTests\Core.Examples.LoadTests.csproj", "{ABA2F0F5-6372-4D7A-9B97-E1089C988B59}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Conversation", "dotnet\Conversation\Conversation.csproj", "{EE94F312-488C-448B-92C9-20C4C1816F16}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down Expand Up @@ -326,6 +328,10 @@ Global
{ABA2F0F5-6372-4D7A-9B97-E1089C988B59}.Debug|Any CPU.Build.0 = Debug|Any CPU
{ABA2F0F5-6372-4D7A-9B97-E1089C988B59}.Release|Any CPU.ActiveCfg = Release|Any CPU
{ABA2F0F5-6372-4D7A-9B97-E1089C988B59}.Release|Any CPU.Build.0 = Release|Any CPU
{EE94F312-488C-448B-92C9-20C4C1816F16}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{EE94F312-488C-448B-92C9-20C4C1816F16}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EE94F312-488C-448B-92C9-20C4C1816F16}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EE94F312-488C-448B-92C9-20C4C1816F16}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -388,6 +394,7 @@ Global
{71DD0475-532B-49C0-8699-6552FF3A4A6E} = {2C948535-3001-4852-9686-492A23E9E356}
{B9ABEB53-19C8-4224-8820-CF2D82DCC559} = {28E0E967-A94D-4820-8A61-0B71D3B2780F}
{ABA2F0F5-6372-4D7A-9B97-E1089C988B59} = {B9ABEB53-19C8-4224-8820-CF2D82DCC559}
{EE94F312-488C-448B-92C9-20C4C1816F16} = {2C948535-3001-4852-9686-492A23E9E356}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {FF5DE858-4B85-4EE8-8A6D-46E8E4FBA078}
Expand Down
2 changes: 1 addition & 1 deletion src/dotnet/AIModel/Models/AIModelReference.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class AIModelReference : ResourceReference
/// The object type of the data source.
/// </summary>
[JsonIgnore]
public Type AIModelType =>
public override Type ResourceType =>
Type switch
{
AIModelTypes.Basic => typeof(AIModelBase),
Expand Down
Loading

0 comments on commit b4acdd9

Please sign in to comment.