Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links in documentation #1426

Merged
merged 5 commits into from
Mar 15, 2024
Merged

Fix links in documentation #1426

merged 5 commits into from
Mar 15, 2024

Conversation

pamelafox
Copy link
Collaborator

@pamelafox pamelafox commented Mar 14, 2024

Purpose

Fixes #1422

This PR fixes links in docs, preferring absolute URLs over relative URLs which are more likely to break if docs get moved around. The absolute URLs seem to work, from my tests.

Also updated a few docs sections while I was in them. :)

Does this introduce a breaking change?

When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
If you're not sure, try it out on an old environment.

[ ] Yes
[X] No

Does this require changes to learn.microsoft.com docs?

This repository is referenced by this tutorial
which includes deployment, settings and usage instructions. If text or screenshot need to change in the tutorial,
check the box below and notify the tutorial author. A Microsoft employee can do this for you if you're an external contributor.

[ ] Yes
[X] No

Type of change

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

Code quality checklist

See CONTRIBUTING.md for more details.

N/A

Copy link

Check Broken Paths

We have automatically detected the following broken relative paths in your lessons. Review and fix the paths to resolve this issue.

Check the file paths and associated broken paths inside them. For more details, check our Contributing Guide.

File Full Path Issues
./docs/login_and_acl.md 1. ./app/backend/core/authentication.py

1 similar comment
Copy link

Check Broken Paths

We have automatically detected the following broken relative paths in your lessons. Review and fix the paths to resolve this issue.

Check the file paths and associated broken paths inside them. For more details, check our Contributing Guide.

File Full Path Issues
./docs/login_and_acl.md 1. ./app/backend/core/authentication.py

@@ -23,7 +24,7 @@ If the maximum TPM isn't enough for your expected load, you have a few options:

* Use a backoff mechanism to retry the request. This is helpful if you're running into a short-term quota due to bursts of activity but aren't over long-term quota. The [tenacity](https://tenacity.readthedocs.io/en/latest/) library is a good option for this, and this [pull request](https://github.com/Azure-Samples/azure-search-openai-demo/pull/500) shows how to apply it to this app.

* If you are consistently going over the TPM, then consider implementing a load balancer between OpenAI instances. Most developers implement that using Azure API Management following [this blog post](https://www.raffertyuy.com/raztype/azure-openai-load-balancing/) or [this repository](https://github.com/andredewes/apim-aoai-smart-loadbalancing). Another approach is to use [LiteLLM's load balancer](https://docs.litellm.ai/docs/providers/azure#azure-api-load-balancing) with Azure Cache for Redis.
* If you are consistently going over the TPM, then consider implementing a load balancer between OpenAI instances. Most developers implement that using Azure API Management using [the openai-apim-lb repo](https://github.com/Azure-Samples/openai-apim-lb) or with Azure Container Apps using [the openai-aca-lb repo](https://github.com/Azure-Samples/openai-aca-lb). Another approach is to use [LiteLLM's load balancer](https://docs.litellm.ai/docs/providers/azure#azure-api-load-balancing) with Azure Cache for Redis.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New load balancer links


## Evaluation

Before you make your chat app available to users, you'll want to rigorously evaluate the answer quality. You can use tools in [the AI RAG Chat evaluator](https://github.com/Azure-Samples/ai-rag-chat-evaluator) repository to run evaluations, review results, and compare answers across runs.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New section to encourage evaluation (this section is also in customizing doc)

@pamelafox
Copy link
Collaborator Author

cc @john0isaac

@john0isaac
Copy link
Contributor

The workflow is not passing it's skipping the URLs now.
To catch the URL by the workflow it needs to start with ./ or ../

Also, the relative reference is needed to be able to evaluate it relatively.

@john0isaac
Copy link
Contributor

for example to fix the comments posted by the workflow you needed to add an extra . in front of the /app
change ./app/backend/core/authentication.py to ../
removing the . dots makes it skip it.

@pamelafox
Copy link
Collaborator Author

Changed to relative paths, and checker is still passing.

@pamelafox pamelafox merged commit a8b6618 into Azure-Samples:main Mar 15, 2024
4 checks passed
@pamelafox pamelafox deleted the linfix branch March 15, 2024 23:57
MyrtheLammerse added a commit to digital-power/chatDiP that referenced this pull request Apr 19, 2024
* Add search scores, models, and deployments to "Thought process" tab, surface additional properties (Azure-Samples#1375)

* update reqs

* Add score, model, styling

* Update tests

* Use a new variable name to avoid type clash

* Use correct variable name in thought process

* Add Markdown/Text Parser (Azure-Samples#1381)

* add markdown parser

* add example file in markdown

* fix formatting and linting errors

* rename company in markdown example file

* rename markdownparser to textparser

* fix typo

* remove empty space from test case

* add txt support + fix import

* Apply suggestions from code review

---------

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

* Fix provision for load balance custom (Azure-Samples#1396)

* Fix provision for lb custom

* Rm unneeded parens

---------

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

* Update data_ingestion.md with correct notebook link (Azure-Samples#1405)

* Bump the github-actions group with 1 update (Azure-Samples#1400)

Bumps the github-actions group with 1 update: [azure/CLI](https://github.com/azure/cli).


Updates `azure/CLI` from 1 to 2
- [Release notes](https://github.com/azure/cli/releases)
- [Changelog](https://github.com/Azure/cli/blob/master/ReleaseProcess.md)
- [Commits](Azure/cli@v1...v2)

---
updated-dependencies:
- dependency-name: azure/CLI
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add needed permissions (Azure-Samples#1411)

* Set Azure OpenAI API version in global configuration (Azure-Samples#1399)

* Set Azure OpenAI API version in global configuration

* Add Variable to CI Configurations

* Set the latest API version as the default value for the variable.

* Update app/backend/app.py

* Add output for Azure OpenAI API version.

* Update app/backend/app.py

---------

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>
Co-authored-by: Pamela Fox <pamelafox@microsoft.com>

* Add markdown checker (Azure-Samples#1377)

* Create validate-markdown.yml

* remove tracking checks

* remove branch reference

* Refactoring of prepdocs for easier integration with user upload feature (Azure-Samples#1407)

* Changes to prepare for upload

* All pass except multilang

* Made mypy happy

* Fix the arguments

* Unit tests for code changes

* 3.9 compatibility

* Remove unused args from prepdocs

* Address feedback

* Ignore typing error after reporting to SDK team

* Don't disable text chunking when GPT4vision is enabled (Azure-Samples#1355)

* Dont disable chunking when using vision, graceful degrade

* Adding test

* Ensure there are no zero-length sections for batch API (Azure-Samples#1423)

* Assert there are no zero-length sections

* Correct the overlap mechanism when the text section doesn't contain any breaks

* Update textsplitter.py

* Update CONTRIBUTING.md (Azure-Samples#1425)

Added an instruction to Compile the JavaScript. This is required for pytest tests to pass.

* Update other_samples.md to reflect current features/tech (Azure-Samples#1388)

* Update other_samples.md

* Add formats list

* Update docs/data_ingestion.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update approach.py (Typo "Azure Open AI"→"Azure OpenAI") (Azure-Samples#1431)

https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/app/backend/approaches/approach.py
#PingMSFTDocs

* Fix links in documentation (Azure-Samples#1426)

* Fix up links in docs

* Fix one more link

* Use relative links

* Update gpt4v.md (Typo "Azure Open AI models"→"Azure OpenAI models") (Azure-Samples#1435)

https://github.com/azure-samples/azure-search-openai-demo/blob/main/docs/gpt4v.md
#PingMSFTDocs

* Add Markdown File Viewer (Azure-Samples#1384)

* add markdown viewer

* fix "</body>"  showing as markdown content for a few seconds in markdown viewer

* fix indentation

* replace markdown library 'uiw/react-markdown-preview' with 'marked'

* update marked

* add comment to explain removal of anchor links

* fix formatting with pre-commit

---------

Co-authored-by: Pamela Fox <pamelafox@microsoft.com>

* Update chatreadretrieveread.py (Typo "Azure Open AI"→"Azure OpenAI") (Azure-Samples#1443)

https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/app/backend/approaches/chatreadretrieveread.py
#PingMSFTDocs

* Update retrievethenread.py (Typo "Azure Open AI"→"Azure OpenAI") (Azure-Samples#1447)

https://github.com/Azure-Samples/azure-search-openai-demo/blob/main/app/backend/approaches/retrievethenread.py
#PingMSFTDocs

* Bump the github-actions group with 1 update (Azure-Samples#1439)

Bumps the github-actions group with 1 update: [actions/checkout](https://github.com/actions/checkout).


Updates `actions/checkout` from 3 to 4
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Add minimum score criteria for AI search results (Azure-Samples#1417)

* Add minimum score criteria for AI search results

* Adjust input to support precise filtering in different search modes.

* Resolve comparison issue

* Update class style

* Fix parsing

* Add test

* Lint

* Format

* Fix tests

---------

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

* Fix search env var (Azure-Samples#1455)

* Allow manual setting of the OpenAI Deployment Name, Version, Capacity and Model (Azure-Samples#1386)

* check for chat or chat4 to enable different deployments

* add docs for deployment

* line ending

* add USE_GPT4

* remove list

* update docs

* Update docs/deploy_features.md

* add version check

* update to use new isAzureOpenAiHost

* precommit formatter

* revert back name of chat and embeddings deployments

* format with black

* Correct names in parameters

* Add embedding version as parameter

* use empty to check for definition

* change 'azure openai chatgpt model' var back to original name

* change 'azure openai chatgpt model' to match embedding model var

* docs: add intruction for gpt-4

* Use previous env var name

---------

Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

* Force soft delete and purge for keyvault (Azure-Samples#1462)

* Added Environment Variables for setting Names of Resources (Azure-Samples#1389)

* Added Environment Variables to allow setting the names of most resources.
+ App Service Plan Name
+ App Service Name (backend service)
+ Application Insights Name
+ Application Insights Dashboard Name
+ Log Analytics Workspace Name

Two Global Resources are created, whose names have not been parameterised. These are
- Action group (Application Insights Smart Detection)
- Smart detector alert rule (Failure Anomalies - $AZURE_APPLICATION_INSIGHTS)

* Added Environment Variables for Computer Vision Name, RG, Location and SKU Parameters

* Computer Vision SKU - Removed incorrect default

* Update azure-dev.yml

Added ENV Variables also to workflow

* Updated deploy_existing.md and pipelines.

* Updated main.bicep variables to show reference to main.parameters.json file. Updated some defaults.

* Expanded allow-list of Document Intelligence regions.

* Reverted my change of Document Intelligence resource locations, since the Preview API is only available in the listed three locations.

* Add empty string default back

* update toc

* bring back comment

---------

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>
Co-authored-by: Pamela Fox <pamelafox@microsoft.com>

* Fix broken links (Azure-Samples#1450)

* Add support for using new ada models with different dimensions (Azure-Samples#1378)

* update reqs

* Add parameters for ada 3

* Update readme

* Update TOC

* Fix tests and mocks

* Mypy fixes

* Addressing feedback (more testing still needed)

* More readme notes

* Cast openaidimensions to int

* Support batch for ada3

* right model name

* Note about regions

* Add constants for tests model name and dimensions

* Default to int

* Typing error

* Fix env var name

* Undo unneeded parameter move

* Dont specify dimensons for old models

* typing

* Update README.md with right links to deploy docs (Azure-Samples#1466)

* Correct datalakepath argument in prepdocs.sh and prepdocs.ps1 (Azure-Samples#1478)

* Configure Azure Developer Pipeline

* Configure Azure Developer Pipeline

* Use correct arg

* Bump the github-actions group with 1 update (Azure-Samples#1474)

Bumps the github-actions group with 1 update: [Azure/setup-azd](https://github.com/azure/setup-azd).


Updates `Azure/setup-azd` from 0.1.0 to 1.0.0
- [Release notes](https://github.com/azure/setup-azd/releases)
- [Changelog](https://github.com/Azure/setup-azd/blob/main/CHANGELOG.md)
- [Commits](Azure/setup-azd@v0.1.0...v1.0.0)

---
updated-dependencies:
- dependency-name: Azure/setup-azd
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Enforce RBAC only for non-free search service (Azure-Samples#1502)

* Configure Azure Developer Pipeline

* Configure Azure Developer Pipeline

* Update pricing calculator link

* Enforce RBAC only for search service

* Rm unneeded change

* Remove it from main.bicep

* Update link to pricing calculator to fix Document Intelligence estimation (Azure-Samples#1480)

* Update pricing link

* Update pricing link

* Update document level access control docs (Azure-Samples#1511)

* update diagram

* refactor doc

* remove locale

* accept reword feedback

* Update docs/login_and_acl.md

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

* Update docs/login_and_acl.md

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

---------

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>

* more updates (Azure-Samples#1512)

* Optional upload documents feature (Azure-Samples#1395)

* Initial commit for upload docs feature

* Working locally

* Move prepdocs into backend, implement delete and list

* Initial upload tests

* Merge from main

* More upload tests

* Another test

* E2E draft

* Added to Ask page, more tests, documentation

* Fix types

* A few adjustments

* Increase test coverage

* Add tests for content path

* Test for 404

* update link

* Add upload test

* Add doc intel role

* Disable button when logged out

* Update prepdocs.ps1 and docs with right path

* Improve deletion and list flow, rm unused CSS, add a test

* Correct product name, remove deleteRetentionPolicy

* Add missing role for adding to index

* Use blob container clients only

* Type mismatch

* Avoid infinite loop in remove_content

* Handle the case of user directory not existing yet

* Add check for directory client

* Resolve typing mismatch

* Need roles specific to each RG

* Simplify test

* fix start.ps1

* Add uploaded file error message

---------

Co-authored-by: Matt Gotteiner <[email protected]>

* Bump pillow from 10.2.0 to 10.3.0 in /app/backend (Azure-Samples#1486)

Bumps [pillow](https://github.com/python-pillow/Pillow) from 10.2.0 to 10.3.0.
- [Release notes](https://github.com/python-pillow/Pillow/releases)
- [Changelog](https://github.com/python-pillow/Pillow/blob/main/CHANGES.rst)
- [Commits](python-pillow/Pillow@10.2.0...10.3.0)

---
updated-dependencies:
- dependency-name: pillow
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Port to the Graph SDK for authentication scripts (Azure-Samples#1510)

* Configure Azure Developer Pipeline

* Configure Azure Developer Pipeline

* Update pricing calculator link

* Port to Graph SDK

* Port to Graph SDK

* Add msgraph to mypy overrides

* Typing fixes

* Use pyproject.toml for everything

* Fix jose jwt exception import

* change import to match stubs

* Disable key-based storage account access in Bicep (Azure-Samples#1518)

* Configure Azure Developer Pipeline

* Configure Azure Developer Pipeline

* Update pricing calculator link

* Disable key access for our storage accounts

* Bump idna from 3.6 to 3.7 in /app/backend (Azure-Samples#1525)

Bumps [idna](https://github.com/kjd/idna) from 3.6 to 3.7.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst)
- [Commits](kjd/idna@v3.6...v3.7)

---
updated-dependencies:
- dependency-name: idna
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump vite from 4.5.2 to 4.5.3 in /app/frontend (Azure-Samples#1488)

Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 4.5.2 to 4.5.3.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v4.5.3/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v4.5.3/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Pamela Fox <pamelafox@microsoft.com>

* ask: remove ask page

* conflict: remove double code

* lint: fix type hinting in authenticated path

* app: fix mypy errors

* tests: change search client to search clients

* test: fix unittests

* test: fix header with usecase app

* test: change name of test data folder

* test: change name of test data folder

* coverage: set limit lower

* ubuntu: add sudo apt-get update before e2e test

* pipeline: check network connectivity

* pipeline: remove ping

* test: remove ask e2e test

* test: remove ask e2e test

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Pamela Fox <pamelafox@microsoft.com>
Co-authored-by: Yuval Yaron <43217306+yuvalyaron@users.noreply.github.com>
Co-authored-by: Pamela Fox <pamela.fox@gmail.com>
Co-authored-by: Dina Berry (MSFT) <diberry@microsoft.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: sogue <61759231+sogue@users.noreply.github.com>
Co-authored-by: John Aziz <johnaziz269@gmail.com>
Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
Co-authored-by: Erin La <107987318+giterinhub@users.noreply.github.com>
Co-authored-by: Hiroshi Yoshioka <40815708+hyoshioka0128@users.noreply.github.com>
Co-authored-by: Matt <matthew.gotteiner@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue] Broken Relative paths
3 participants