From 2d6095e1ec39fcb2a1f1eabf8ad877f45ef0ca6c Mon Sep 17 00:00:00 2001 From: saimachi Date: Sun, 25 Feb 2024 09:24:56 -0500 Subject: [PATCH 1/4] Updated request schemas. Note about logical deletion. --- deploy/starter/README.md | 1 + docs/setup-guides/agents/internal-context-agent.md | 6 ++++-- docs/setup-guides/agents/knowledge-management-agent.md | 6 ++++-- docs/setup-guides/agents/prompt-resource.md | 6 ++++-- docs/setup-guides/vectorization/vectorization-profiles.md | 8 ++++++++ 5 files changed, 21 insertions(+), 6 deletions(-) diff --git a/deploy/starter/README.md b/deploy/starter/README.md index 8d9668880a..72d5811a1a 100644 --- a/deploy/starter/README.md +++ b/deploy/starter/README.md @@ -8,6 +8,7 @@ Mac and Linux users can install the following dependencies locally to run the de - [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) - [jq](https://jqlang.github.io/jq/download/) - [Docker Desktop](https://www.docker.com/products/docker-desktop/) +- [git](https://git-scm.com/downloads) ### azd CLI diff --git a/docs/setup-guides/agents/internal-context-agent.md b/docs/setup-guides/agents/internal-context-agent.md index 7c3a60ac32..9118030428 100644 --- a/docs/setup-guides/agents/internal-context-agent.md +++ b/docs/setup-guides/agents/internal-context-agent.md @@ -8,8 +8,8 @@ The structure of an internal context agent is the following: ```json { - "name": "", "type": "internal-context", + "name": "", "object_id": "/instances//providers/FoundationaLLM.Agent/agents/", "description": "", "language_model": { @@ -47,8 +47,8 @@ where: | Parameter | Description | | --- | --- | +| `type` | The type of the agent - will always be `internal-context`. **`type` must be the first parameter in the request body.** | | `name` | The name of the agent. | -| `type` | The type of the agent - will always be `internal-context`. | | `object_id` | The object ID of the agent. Remove this element when creating an agent as this is generated by the Management API. | | `description` | The description of the agent, ensure this description details the purpose of the agent. | | `language_model` | The language model configuration. This sample demonstrates the usage of the Azure OpenAI language model. | @@ -98,6 +98,8 @@ where `` is the JSON agent configuration structure describe HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Agent/agents/ ``` +>**Note:** FLLM currently implements logical deletes for Internal Context agents. This means that users cannot create an Internal Context agent with the same name as a deleted Internal Context agent. Support for purging Internal Context agents will be added in a future release. + ## Validating an internal context agent Once configured, the internal context agent can be validated using an API call to the [Core API](../exposed-apis/core-api.md) or via the [User Portal](../quickstart.md). diff --git a/docs/setup-guides/agents/knowledge-management-agent.md b/docs/setup-guides/agents/knowledge-management-agent.md index 31907688d0..a02c7a2cd1 100644 --- a/docs/setup-guides/agents/knowledge-management-agent.md +++ b/docs/setup-guides/agents/knowledge-management-agent.md @@ -24,8 +24,8 @@ The structure of a knowledge management agent is the following: ```json { - "name": "", "type": "knowledge-management", + "name": "", "object_id": "/instances//providers/FoundationaLLM.Agent/agents/", "description": "", "indexing_profile_object_id": "", @@ -69,8 +69,8 @@ where: | Parameter | Description | | --- | --- | +| `type` | The type of the agent - will always be `knowledge-management`. **`type` must be the first key in the request body.** | | `name` | The name of the agent. | -| `type` | The type of the agent - will always be `knowledge-management`. | | `object_id` | The object ID of the agent. Remove this element when creating an agent as this is generated by the Management API. | | `description` | The description of the agent, ensure this description details the purpose of the agent. | | `indexing_profile_object_id` | The object ID of the indexing profile resource. | @@ -123,6 +123,8 @@ where `` is the JSON agent configuration structure describe HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Agent/agents/ ``` +>**Note:** FLLM currently implements logical deletes for Knowledge Management agents. This means that users cannot create a Knowledge Management agent with the same name as a deleted Knowledge Management agent. Support for purging Knowledge Management agents will be added in a future release. + ## Validating a knowledge management agent Once configured, the knowledge management agent can be validated using an API call to the [Core API](../exposed-apis/core-api.md) or via the [User Portal](../quickstart.md). diff --git a/docs/setup-guides/agents/prompt-resource.md b/docs/setup-guides/agents/prompt-resource.md index 6eb7bb7fd3..b50d9dc68e 100644 --- a/docs/setup-guides/agents/prompt-resource.md +++ b/docs/setup-guides/agents/prompt-resource.md @@ -8,8 +8,8 @@ The structure of a prompt is the following: ```json { + "type": "multipart", "name": "", - "type": "prompt", "object_id": "/instances//providers/FoundationaLLM.Prompt/prompts/", "description": "", "prefix": "", @@ -27,8 +27,8 @@ where: | Parameter | Description | | --- | --- | +| `type` | The type - will be `multipart`. `multipart` prompts have a prefix and suffix. Support for `basic` prompts, which have no suffix, will be added in a future release. **`type` must be the first parameter in the request body.** | | `name` | The name of the prompt. | -| `type` | The type - will always be `prompt`. | | `object_id` | The object ID of the prompt. Remove this element when creating an prompt as this is generated by the Management API. | | `description` | The description of the prompt, ensure this description details the purpose or role of the prompt. | | `prompt_prefix` | The beginning of the prompt. | @@ -61,3 +61,5 @@ where `` is the prompt configuration structure described a ```http HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Prompt/prompts/ ``` + +>**Note:** FLLM currently implements logical deletes for Prompts. This means that users cannot create a Prompt with the same name as a deleted Prompt. Support for purging Prompts will be added in a future release. diff --git a/docs/setup-guides/vectorization/vectorization-profiles.md b/docs/setup-guides/vectorization/vectorization-profiles.md index 43fc150675..e0a04b4f39 100644 --- a/docs/setup-guides/vectorization/vectorization-profiles.md +++ b/docs/setup-guides/vectorization/vectorization-profiles.md @@ -110,6 +110,8 @@ where `` is a JSON object with the structure described a HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/contentsourceprofiles/ ``` +>**Note:** FLLM implements a *logical delete* for Content Source profiles. This means that users cannot create a Content Source profile with the same name as a deleted profile. Support for purging Content Source profiles will be added in a future release. + ## Text partitioning profiles The structure of a text partitioning profile is the following: @@ -182,6 +184,8 @@ where `` is a JSON object with the structure describe HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/textpartitioningprofiles/ ``` +>**Note:** FLLM implements a *logical delete* for Text Partitioning profiles. This means that users cannot create a Text Partitioning profile with the same name as a deleted profile. Support for purging Text Partitioning profiles will be added in a future release. + ## Text embedding profiles The structure of a text embedding profile is the following: @@ -254,6 +258,8 @@ where `` is a JSON object with the structure described a HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/textembeddingprofiles/ ``` +>**Note:** FLLM implements a *logical delete* for Text Embedding profiles. This means that users cannot create a Text Embedding profile with the same name as a deleted profile. Support for purging Text Embedding profiles will be added in a future release. + ## Indexing profiles The structure of an indexing profile is the following: @@ -327,6 +333,8 @@ where `` is a JSON object with the structure described above. HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/indexingprofiles/ ``` +>**Note:** FLLM implements a *logical delete* for Text Indexing profiles. This means that users cannot create a Text Indexing profile with the same name as a deleted profile. Support for purging Text Indexing profiles will be added in a future release. + ## Additional configuration steps ### Entra ID app registration for SharePoint Online content source From ef1e577cd0e26c3451afca130a657b4bd02e8abd Mon Sep 17 00:00:00 2001 From: saimachi Date: Sun, 25 Feb 2024 10:22:28 -0500 Subject: [PATCH 2/4] Added more App Config keys. --- docs/deployment/app-configuration-values.md | 25 ++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/deployment/app-configuration-values.md b/docs/deployment/app-configuration-values.md index 4baf19fdf2..f5a8c67e69 100644 --- a/docs/deployment/app-configuration-values.md +++ b/docs/deployment/app-configuration-values.md @@ -15,6 +15,7 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:APIs:AgentFactoryAPI:APIKey` | Key Vault secret name: `foundationallm-apis-agentfactoryapi-apikey` | This is a Key Vault reference. | | `FoundationaLLM:APIs:AgentFactoryAPI:APIUrl` | Enter the URL to the service. | | | `FoundationaLLM:APIs:AgentFactoryAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. | +| `FoundationaLLM:APIs:AgentFactoryAPI:ForceHttpsRedirection` | false | | | `FoundationaLLM:APIs:AgentHubAPI:APIKey` | Key Vault secret name: `foundationallm-apis-agenthubapi-apikey` | This is a Key Vault reference. | | `FoundationaLLM:APIs:AgentHubAPI:APIUrl` | Enter the URL to the service. | | | `FoundationaLLM:APIs:AgentHubAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. | @@ -29,8 +30,10 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:APIs:GatekeeperAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. | | `FoundationaLLM:APIs:GatekeeperAPI:Configuration:EnableAzureContentSafety` | true | By default, the Gatekeeper API has Azure Content Safety integration enabled. To disable this feature, set this value to false. | | `FoundationaLLM:APIs:GatekeeperAPI:Configuration:EnableMicrosoftPresidio` | true | By default, the Gatekeeper API has Microsoft Presidio integration enabled. To disable this feature, set this value to false. | +| `FoundationaLLM:APIs:GatekeeperAPI:ForceHttpsRedirection` | false | | | `FoundationaLLM:APIs:GatekeeperIntegrationAPI:APIKey` | Key Vault secret name: `foundationallm-apis-gatekeeperintegrationapi-apikey` | This is a Key Vault reference. | | `FoundationaLLM:APIs:GatekeeperIntegrationAPI:APIUrl` | Enter the URL to the service. | | +| `FoundationaLLM:APIs:GatekeeperIntegrationAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. | | `FoundationaLLM:APIs:LangChainAPI:APIKey` | Key Vault secret name: `foundationallm-apis-langchainapi-apikey` | This is a Key Vault reference. | | `FoundationaLLM:APIs:LangChainAPI:APIUrl` | Enter the URL to the service. | | | `FoundationaLLM:APIs:LangChainAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. | @@ -44,6 +47,7 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:APIs:SemanticKernelAPI:APIKey` | Key Vault secret name: `foundationallm-apis-semantickernelapi-apikey` | This is a Key Vault reference. | | `FoundationaLLM:APIs:SemanticKernelAPI:APIUrl` | Enter the URL to the service. | | | `FoundationaLLM:APIs:SemanticKernelAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. | +| `FoundationaLLM:APIs:SemanticKernelAPI:ForceHttpsRedirection` | false | | | `FoundationaLLM:AzureContentSafety:APIKey` | Key Vault secret name: `foundationallm-azurecontentsafety-apikey` | This is a Key Vault reference. | | `FoundationaLLM:AzureContentSafety:APIUrl` | Enter the URL to the service. | | | `FoundationaLLM:AzureContentSafety:HateSeverity` | 2 | | @@ -127,6 +131,7 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:Management:Entra:Instance` | Enter the URL to the service. | | | `FoundationaLLM:Management:Entra:Scopes` | api://FoundationaLLM-Management-Auth/Data.Manage | | | `FoundationaLLM:Management:Entra:TenantId` | | | +| `FoundationaLLM:ManagementAPI:Entra:CallbackPath` | `/signin-oidc` || | `FoundationaLLM:ManagementAPI:Entra:ClientId` | | | | `FoundationaLLM:ManagementAPI:Entra:ClientSecret` | Key Vault secret name: `foundationallm-managementapi-entra-clientsecret` | This is a Key Vault reference. | | `FoundationaLLM:ManagementAPI:Entra:Instance` | Enter the URL to the service. | | @@ -156,6 +161,7 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:APIs:VectorizationAPI:APIUrl` | | The URL of the vectorization API. | | `FoundationaLLM:APIs:VectorizationAPI:APIKey` | Key Vault secret name: `foundationallm-apis-vectorizationapi-apikey` | The API key of the vectorization API. | | `FoundationaLLM:APIs:VectorizationAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | The connection string to the Application Insights instance used by the vectorization API. | +| `FoundationaLLM:APIs:VectorizationAPI:ForceHttpsRedirection` | false | | | `FoundationaLLM:APIs:VectorizationWorker:APIUrl` | | The URL of the vectorization worker API. | | `FoundationaLLM:APIs:VectorizationWorker:APIKey` | Key Vault secret name: `foundationallm-apis-vectorizationworker-apikey` | The API key of the vectorization worker API. | | `FoundationaLLM:APIs:VectorizationWorker:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | The connection string to the Application Insights instance used by the vectorization worker API. | @@ -165,7 +171,7 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:Vectorization:Queues:Index:ConnectionString` | Key Vault secret name: `foundationallm-vectorization-queues-connectionstring` | The connection string to the Azure Storage account used for the index vectorization queue. | | `FoundationaLLM:Vectorization:Queues:Partition:ConnectionString` | Key Vault secret name: `foundationallm-vectorization-queues-connectionstring` | The connection string to the Azure Storage account used for the partition vectorization queue. | | `FoundationaLLM:Vectorization:StateService:Storage:AuthenticationType` | | The authentication type used to connect to the underlying storage. Can be one of `AzureIdentity`, `AccountKey`, or `ConnectionString`. | -| `FoundationaLLM:Vectorization:StateService:Storage:ConnectionString` | Key Vault secret name: `foundationallm-vectorization-state-connectionstring` | The connection string to the Azure Storage account used for the vectorization state service. | +| `FoundationaLLM:Vectorization:StateService:Storage:ConnectionString` | Key Vault secret name: `storage-connection` | The connection string to the Azure Storage account used for the vectorization state service. | | `FoundationaLLM:Vectorization:ResourceProviderService:Storage:AuthenticationType` | | The authentication type used to connect to the underlying storage. Can be one of `AzureIdentity`, `AccountKey`, or `ConnectionString`. | | `FoundationaLLM:Vectorization:ResourceProviderService:Storage:ConnectionString` | Key Vault secret name: `foundationallm-vectorization-resourceprovider-storage-connectionstring` | The connection string to the Azure Storage account used for the vectorization state service. | | `FoundationaLLM:Events:AzureEventGridEventService:APIKey` | Key Vault secret name: `foundationallm-events-azureeventgrid-apikey` | The API key used to access FLLM's Event Grid namespace. | @@ -177,6 +183,23 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:Events:AzureEventGridEventService:Profiles:ManagementAPI` | | FLLM eventing infrastructure configuration for the Management API. | | `FoundationaLLM:Events:AzureEventGridEventService:Profiles:VectorizationAPI` | | FLLM eventing infrastructure configuration for the Vectorization API. | | `FoundationaLLM:Events:AzureEventGridEventService:Profiles:VectorizationWorker` | | FLLM eventing infrastructure configuration for the Vectorization Worker. | +| `FoundationaLLM:Configuration:ResourceProviderService:Storage:AuthenticationType` | | The authentication type used to connect to the underlying storage. Can be one of `AzureIdentity`, `AccountKey`, or `ConnectionString`. | +| `FoundationaLLM:Configuration:ResourceProviderService:Storage:ConnectionString` | Key Vault secret name: `foundationallm-configuration-resourceprovider-storage-connectionstring` | This is a Key Vault reference. | +| `FoundationaLLM:Vectorization:AzureAISearchIndexingService:AuthenticationType` | `APIKey` | | +| `FoundationaLLM:Vectorization:AzureAISearchIndexingService:APIKey` | Key Vault secret name: `search-key` | This is a Key Vault reference. | +| `FoundationaLLM:Vectorization:AzureAISearchIndexingService:Endpoint` | | Azure AI Search service endpoint. | +| `FoundationaLLM:Vectorization:AzureAISearchIndexingService:QueryAPIKey` | Key Vault secret name: `search-key` | This is a Key Vault reference. | +| `FoundationaLLM:Vectorization:ContentSources:DefaultAzureDataLake:AuthenticationType` | `ConnectionString` | This is a Key Vault reference. | +| `FoundationaLLM:Vectorization:ContentSources:DefaultAzureDataLake:ConnectionString` | Key Vault secret name: `search-key` | This is a Key Vault reference. | +| `FoundationaLLM:Vectorization:SemanticKernelTextEmbeddingService:APIVersion` | `2023-05-15` | | +| `FoundationaLLM:Vectorization:SemanticKernelTextEmbeddingService:DeploymentName` | `embeddings` | | +| `FoundationaLLM:Vectorization:SemanticKernelTextEmbeddingService:Endpoint` | Enter the URL to the service. | | +| `FoundationaLLM:VectorizationAPI:Entra:CallbackPath` | /signin-oidc | | +| `FoundationaLLM:VectorizationAPI:Entra:ClientId` | | | +| `FoundationaLLM:VectorizationAPI:Entra:ClientSecret` | Key Vault secret name: `foundationallm-apis-management-api-entra-clientsecret` | This is a Key Vault reference. | +| `FoundationaLLM:VectorizationAPI:Entra:Instance` | Enter the URL to the service. | | +| `FoundationaLLM:VectorizationAPI:Entra:Scopes` | api://FoundationaLLM-Vectorization/Data.Manage | | +| `FoundationaLLM:VectorizationAPI:Entra:TenantId` | | | ## Feature flags From 9d0a4123c1b4d3c032731e80e9940ea011138119 Mon Sep 17 00:00:00 2001 From: saimachi Date: Sun, 25 Feb 2024 10:54:23 -0500 Subject: [PATCH 3/4] Formatting clean-up. --- docs/deployment/app-configuration-values.md | 2 +- docs/setup-guides/agents/internal-context-agent.md | 3 ++- .../agents/knowledge-management-agent.md | 3 ++- docs/setup-guides/agents/prompt-resource.md | 3 ++- .../vectorization/vectorization-profiles.md | 12 ++++++++---- 5 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/deployment/app-configuration-values.md b/docs/deployment/app-configuration-values.md index f5a8c67e69..ba5340eb31 100644 --- a/docs/deployment/app-configuration-values.md +++ b/docs/deployment/app-configuration-values.md @@ -131,7 +131,7 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V | `FoundationaLLM:Management:Entra:Instance` | Enter the URL to the service. | | | `FoundationaLLM:Management:Entra:Scopes` | api://FoundationaLLM-Management-Auth/Data.Manage | | | `FoundationaLLM:Management:Entra:TenantId` | | | -| `FoundationaLLM:ManagementAPI:Entra:CallbackPath` | `/signin-oidc` || +| `FoundationaLLM:ManagementAPI:Entra:CallbackPath` | `/signin-oidc` | | | `FoundationaLLM:ManagementAPI:Entra:ClientId` | | | | `FoundationaLLM:ManagementAPI:Entra:ClientSecret` | Key Vault secret name: `foundationallm-managementapi-entra-clientsecret` | This is a Key Vault reference. | | `FoundationaLLM:ManagementAPI:Entra:Instance` | Enter the URL to the service. | | diff --git a/docs/setup-guides/agents/internal-context-agent.md b/docs/setup-guides/agents/internal-context-agent.md index 9118030428..3bb740e8f1 100644 --- a/docs/setup-guides/agents/internal-context-agent.md +++ b/docs/setup-guides/agents/internal-context-agent.md @@ -98,7 +98,8 @@ where `` is the JSON agent configuration structure describe HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Agent/agents/ ``` ->**Note:** FLLM currently implements logical deletes for Internal Context agents. This means that users cannot create an Internal Context agent with the same name as a deleted Internal Context agent. Support for purging Internal Context agents will be added in a future release. +> [!NOTE] +> FLLM currently implements logical deletes for Internal Context agents. This means that users cannot create an Internal Context agent with the same name as a deleted Internal Context agent. Support for purging Internal Context agents will be added in a future release. ## Validating an internal context agent diff --git a/docs/setup-guides/agents/knowledge-management-agent.md b/docs/setup-guides/agents/knowledge-management-agent.md index a02c7a2cd1..051aae8e7e 100644 --- a/docs/setup-guides/agents/knowledge-management-agent.md +++ b/docs/setup-guides/agents/knowledge-management-agent.md @@ -123,7 +123,8 @@ where `` is the JSON agent configuration structure describe HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Agent/agents/ ``` ->**Note:** FLLM currently implements logical deletes for Knowledge Management agents. This means that users cannot create a Knowledge Management agent with the same name as a deleted Knowledge Management agent. Support for purging Knowledge Management agents will be added in a future release. +> [!NOTE] +> FLLM currently implements logical deletes for Knowledge Management agents. This means that users cannot create a Knowledge Management agent with the same name as a deleted Knowledge Management agent. Support for purging Knowledge Management agents will be added in a future release. ## Validating a knowledge management agent diff --git a/docs/setup-guides/agents/prompt-resource.md b/docs/setup-guides/agents/prompt-resource.md index b50d9dc68e..c5d9a096f6 100644 --- a/docs/setup-guides/agents/prompt-resource.md +++ b/docs/setup-guides/agents/prompt-resource.md @@ -62,4 +62,5 @@ where `` is the prompt configuration structure described a HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Prompt/prompts/ ``` ->**Note:** FLLM currently implements logical deletes for Prompts. This means that users cannot create a Prompt with the same name as a deleted Prompt. Support for purging Prompts will be added in a future release. +> [!NOTE] +> FLLM currently implements logical deletes for Prompts. This means that users cannot create a Prompt with the same name as a deleted Prompt. Support for purging Prompts will be added in a future release. diff --git a/docs/setup-guides/vectorization/vectorization-profiles.md b/docs/setup-guides/vectorization/vectorization-profiles.md index e0a04b4f39..378b4ac98d 100644 --- a/docs/setup-guides/vectorization/vectorization-profiles.md +++ b/docs/setup-guides/vectorization/vectorization-profiles.md @@ -110,7 +110,8 @@ where `` is a JSON object with the structure described a HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/contentsourceprofiles/ ``` ->**Note:** FLLM implements a *logical delete* for Content Source profiles. This means that users cannot create a Content Source profile with the same name as a deleted profile. Support for purging Content Source profiles will be added in a future release. +> [!NOTE] +> FLLM implements a *logical delete* for Content Source profiles. This means that users cannot create a Content Source profile with the same name as a deleted profile. Support for purging Content Source profiles will be added in a future release. ## Text partitioning profiles @@ -184,7 +185,8 @@ where `` is a JSON object with the structure describe HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/textpartitioningprofiles/ ``` ->**Note:** FLLM implements a *logical delete* for Text Partitioning profiles. This means that users cannot create a Text Partitioning profile with the same name as a deleted profile. Support for purging Text Partitioning profiles will be added in a future release. +> [!NOTE] +> FLLM implements a *logical delete* for Text Partitioning profiles. This means that users cannot create a Text Partitioning profile with the same name as a deleted profile. Support for purging Text Partitioning profiles will be added in a future release. ## Text embedding profiles @@ -258,7 +260,8 @@ where `` is a JSON object with the structure described a HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/textembeddingprofiles/ ``` ->**Note:** FLLM implements a *logical delete* for Text Embedding profiles. This means that users cannot create a Text Embedding profile with the same name as a deleted profile. Support for purging Text Embedding profiles will be added in a future release. +> [!NOTE] +> FLLM implements a *logical delete* for Text Embedding profiles. This means that users cannot create a Text Embedding profile with the same name as a deleted profile. Support for purging Text Embedding profiles will be added in a future release. ## Indexing profiles @@ -333,7 +336,8 @@ where `` is a JSON object with the structure described above. HTTP DELETE {{baseUrl}}/instances/{{instanceId}}/providers/FoundationaLLM.Vectorization/indexingprofiles/ ``` ->**Note:** FLLM implements a *logical delete* for Text Indexing profiles. This means that users cannot create a Text Indexing profile with the same name as a deleted profile. Support for purging Text Indexing profiles will be added in a future release. +> [!NOTE] +> FLLM implements a *logical delete* for Text Indexing profiles. This means that users cannot create a Text Indexing profile with the same name as a deleted profile. Support for purging Text Indexing profiles will be added in a future release. ## Additional configuration steps From eb910a1b1b033fd1ad4bb4fe6260eb25442bcb57 Mon Sep 17 00:00:00 2001 From: saimachi Date: Mon, 26 Feb 2024 08:02:56 -0500 Subject: [PATCH 4/4] Removed WSL mentions. --- deploy/starter/README.md | 16 +++++++++++++--- docs/deployment/deployment-starter.md | 19 +++++++++++++------ 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/deploy/starter/README.md b/deploy/starter/README.md index 72d5811a1a..648e9a8928 100644 --- a/deploy/starter/README.md +++ b/deploy/starter/README.md @@ -2,8 +2,9 @@ ## Dependencies -Mac and Linux users can install the following dependencies locally to run the deployment. Windows users should use Ubuntu on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to run all deployment steps. Other WSL Linux distributions may work, but these instructions have been validated with Ubuntu 18.04, 20.04, and 22.04. +Please install the following dependencies to deploy FLLM. +- [PowerShell 7](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.4) (required for `pwsh` to work in the AZD hooks as an alias to powershell) - [azd CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd) - [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) - [jq](https://jqlang.github.io/jq/download/) @@ -25,7 +26,7 @@ Clone the FoundationaLLM repository git clone -b release/0.4.0 https://github.com/solliancenet/foundationallm ``` -Run the following commands to set the appropriate application registration settings for OIDC authentication. **Windows users should run them in WSL.** +Run the following commands to set the appropriate application registration settings for OIDC authentication. ```bash cd foundationallm @@ -60,12 +61,21 @@ azd env set ENTRA_VECTORIZATION_API_TENANT_ID azd env set FOUNDATIONALLM_INSTANCE_ID ``` ->**Note:** You need to manually generate a GUID for your instance ID. +>[!NOTE] +> You need to manually generate a GUID for `FOUNDATIONALLM_INSTANCE_ID`. + +Bash: ```bash uuidgen ``` +PowerShell: + +```powershell +[guid]::NewGuid().ToString() +``` + After setting the OIDC-specific settings in the AZD environment above, run `azd up` in the same folder location to build the Docker images, provision the infrastructure, update the App Configuration entries, deploy the API and web app services, and import files into the storage account. ```bash diff --git a/docs/deployment/deployment-starter.md b/docs/deployment/deployment-starter.md index 3a97b08e40..b10761df22 100644 --- a/docs/deployment/deployment-starter.md +++ b/docs/deployment/deployment-starter.md @@ -10,7 +10,7 @@ Foundationa**LLM** deploys into your own Azure Subscription. By default, it will - Docker Desktop. - Azure CLI ([v2.51.0 or greater](https://docs.microsoft.com/cli/azure/install-azure-cli)). - Azure Developer CLI ([v1.6.1 or greater](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd)) -- Powershell 7 ([7.4.1 or greater](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4)) +- PowerShell 7 ([7.4.1 or greater](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.4)) > Note: Powershell 7 is required for `pwsh` to work in the AZD hooks as an alias to `powershell` - Visual Studio 2022 (only needed if you plan to run/debug the solution locally). - Minimum quota of 65 CPUs across all VM family types. Start here to [Manage VM Quotas](https://learn.microsoft.com/azure/quotas/per-vm-quota-requests). @@ -35,9 +35,7 @@ Follow the steps below to deploy the solution to your Azure subscription. You wi git clone -b release/0.4.0 https://github.com/solliancenet/foundationallm.git ``` -3. **Windows users should use Ubuntu in WSL, opened in the `foundationallm` directory, for the following steps; Mac and Linux users can follow them locally.** - - Run the following commands to set the appropriate application registration settings for OIDC authentication. Please refer to the instructions on the [authentication setup page](authentication/index.md) to configure authentication for the solution and obtain the appropriate client Ids, scopes, and tenant Ids for the following steps. +3. Run the following commands to set the appropriate application registration settings for OIDC authentication. Please refer to the instructions on the [authentication setup page](authentication/index.md) to configure authentication for the solution and obtain the appropriate client Ids, scopes, and tenant Ids for the following steps. ```bash cd deploy/starter @@ -71,12 +69,21 @@ Follow the steps below to deploy the solution to your Azure subscription. You wi azd env set FOUNDATIONALLM_INSTANCE_ID ``` - >**Note:** You need to manually generate a GUID for `FOUNDATIONALLM_INSTANCE_ID`. + >[!NOTE] + > You need to manually generate a GUID for `FOUNDATIONALLM_INSTANCE_ID`. + + Bash: ```bash uuidgen ``` + PowerShell: + + ```powershell + [guid]::NewGuid().ToString() + ``` + After setting the OIDC-specific settings in the AZD environment above, run `azd up` in the same folder location to build the Docker images, provision the infrastructure, update the App Configuration entries, deploy the API and web app services, and import files into the storage account. ```bash @@ -89,7 +96,7 @@ Follow the instructions on the [authentication setup page](authentication/index. ## Update APIs and portals from local code changes -To update all APIs and portals from local code changes, run the following from the `./deploy/starter` folder in your locally cloned repository. Again, Windows users should use WSL. +To update all APIs and portals from local code changes, run the following from the `./deploy/starter` folder in your locally cloned repository. ```bash azd deploy