|
| 1 | +# Introduction |
| 2 | +Below are some flows to follow to make sure code changes are tested effectivly and efficiently. |
| 3 | +The goal is to make sure that this is repeatable and can be done by anyone to avoid regressions. |
| 4 | + |
| 5 | +## Test Case Flows |
| 6 | +- with data, streaming |
| 7 | +- with data, non streaming |
| 8 | +- without data, streaming |
| 9 | +- without data, non streaming |
| 10 | +- All of the above with and without chat history |
| 11 | + |
| 12 | +### With Data, Streaming |
| 13 | +The following environment variables are required to run this test case: |
| 14 | + |
| 15 | +`AZURE_SEARCH_SERVICE`\ |
| 16 | +`AZURE_SEARCH_INDEX`\ |
| 17 | +`AZURE_SEARCH_KEY` |
| 18 | + |
| 19 | +`AZURE_OPENAI_STREAM` should be set to `true` |
| 20 | + |
| 21 | +### With Data, Streaming, Chat History |
| 22 | +Keep the same environment variables as above, but add the following: |
| 23 | + |
| 24 | +`AZURE_COSMOSDB_DATABASE`\ |
| 25 | +`AZURE_COSMOSDB_ACCOUNT`\ |
| 26 | +`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\ |
| 27 | +`AZURE_COSMOSDB_ACCOUNT_KEY` |
| 28 | + |
| 29 | +### With Data, Nonstreaming |
| 30 | +The following environment variables are required to run this test case: |
| 31 | +`AZURE_SEARCH_SERVICE`\ |
| 32 | +`AZURE_SEARCH_INDEX`\ |
| 33 | +`AZURE_SEARCH_KEY` |
| 34 | + |
| 35 | +`AZURE_OPENAI_STREAM` should be set to `false` |
| 36 | + |
| 37 | +### With Data, Nonstreaming, Chat History |
| 38 | +Keep the same environment variables as above, but add the following: |
| 39 | + |
| 40 | +`AZURE_COSMOSDB_DATABASE`\ |
| 41 | +`AZURE_COSMOSDB_ACCOUNT`\ |
| 42 | +`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\ |
| 43 | +`AZURE_COSMOSDB_ACCOUNT_KEY` |
| 44 | + |
| 45 | +### Without Data, Streaming |
| 46 | +The following environment variables should **not** be set: |
| 47 | + |
| 48 | +`AZURE_SEARCH_SERVICE`\ |
| 49 | +`AZURE_SEARCH_INDEX`\ |
| 50 | +`AZURE_SEARCH_KEY` |
| 51 | + |
| 52 | +`AZURE_OPENAI_STREAM` should be set to `true` |
| 53 | + |
| 54 | +### Without Data, Streaming, Chat History |
| 55 | +Keep the same environment variables as above, but add the following: |
| 56 | + |
| 57 | +`AZURE_COSMOSDB_DATABASE`\ |
| 58 | +`AZURE_COSMOSDB_ACCOUNT`\ |
| 59 | +`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\ |
| 60 | +`AZURE_COSMOSDB_ACCOUNT_KEY` |
| 61 | + |
| 62 | +### Without Data, Nonstreaming |
| 63 | +The following environment variables should **not** be set: |
| 64 | + |
| 65 | +`AZURE_SEARCH_SERVICE`\ |
| 66 | +`AZURE_SEARCH_INDEX`\ |
| 67 | +`AZURE_SEARCH_KEY` |
| 68 | + |
| 69 | +`AZURE_OPENAI_STREAM` should be set to `false` |
| 70 | + |
| 71 | +### Without Data, Nonstreaming, Chat History |
| 72 | +Keep the same environment variables as above, but add the following: |
| 73 | + |
| 74 | +`AZURE_COSMOSDB_DATABASE`\ |
| 75 | +`AZURE_COSMOSDB_ACCOUNT`\ |
| 76 | +`AZURE_COSMOSDB_CONVERSATIONS_CONTAINER`\ |
| 77 | +`AZURE_COSMOSDB_ACCOUNT_KEY` |
0 commit comments