Skip to content

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
dluc committed Nov 12, 2024
1 parent 28ee495 commit 475e584
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 11 deletions.
9 changes: 8 additions & 1 deletion applications/tests/Evaluation.Tests/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,14 @@
"UseHybridSearch": false,
// Helps improve relevance score consistency for search services with multiple replicas by
// attempting to route a given request to the same replica for that session. Use this when
// favoring consistent scoring over lower latency.
// favoring consistent scoring over lower latency. Can adversely affect performance.
//
// Whether to use sticky sessions, which can help getting more consistent results.
// When using sticky sessions, a best-effort attempt will be made to target the same replica set.
// Be wary that reusing the same replica repeatedly can interfere with the load balancing of
// the requests across replicas and adversely affect the performance of the search service.
//
// See https://learn.microsoft.com/rest/api/searchservice/documents/search-post?view=rest-searchservice-2024-07-01&tabs=HTTP#request-body
"UseSessionId": false
},
"OpenAI": {
Expand Down
9 changes: 8 additions & 1 deletion examples/002-dotnet-Serverless/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,14 @@
"UseHybridSearch": false,
// Helps improve relevance score consistency for search services with multiple replicas by
// attempting to route a given request to the same replica for that session. Use this when
// favoring consistent scoring over lower latency.
// favoring consistent scoring over lower latency. Can adversely affect performance.
//
// Whether to use sticky sessions, which can help getting more consistent results.
// When using sticky sessions, a best-effort attempt will be made to target the same replica set.
// Be wary that reusing the same replica repeatedly can interfere with the load balancing of
// the requests across replicas and adversely affect the performance of the search service.
//
// See https://learn.microsoft.com/rest/api/searchservice/documents/search-post?view=rest-searchservice-2024-07-01&tabs=HTTP#request-body
"UseSessionId": false
},
"OpenAI": {
Expand Down
9 changes: 8 additions & 1 deletion examples/210-KM-without-builder/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,14 @@
"UseHybridSearch": false,
// Helps improve relevance score consistency for search services with multiple replicas by
// attempting to route a given request to the same replica for that session. Use this when
// favoring consistent scoring over lower latency.
// favoring consistent scoring over lower latency. Can adversely affect performance.
//
// Whether to use sticky sessions, which can help getting more consistent results.
// When using sticky sessions, a best-effort attempt will be made to target the same replica set.
// Be wary that reusing the same replica repeatedly can interfere with the load balancing of
// the requests across replicas and adversely affect the performance of the search service.
//
// See https://learn.microsoft.com/rest/api/searchservice/documents/search-post?view=rest-searchservice-2024-07-01&tabs=HTTP#request-body
"UseSessionId": false
},
"AzureAIDocIntel": {
Expand Down
9 changes: 8 additions & 1 deletion examples/401-evaluation/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,14 @@
"UseHybridSearch": false,
// Helps improve relevance score consistency for search services with multiple replicas by
// attempting to route a given request to the same replica for that session. Use this when
// favoring consistent scoring over lower latency.
// favoring consistent scoring over lower latency. Can adversely affect performance.
//
// Whether to use sticky sessions, which can help getting more consistent results.
// When using sticky sessions, a best-effort attempt will be made to target the same replica set.
// Be wary that reusing the same replica repeatedly can interfere with the load balancing of
// the requests across replicas and adversely affect the performance of the search service.
//
// See https://learn.microsoft.com/rest/api/searchservice/documents/search-post?view=rest-searchservice-2024-07-01&tabs=HTTP#request-body
"UseSessionId": false
},
"OpenAI": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,14 @@ public enum AuthTypes
/// <summary>
/// Helps improve relevance score consistency for search services with multiple replicas by
/// attempting to route a given request to the same replica for that session. Use this when
/// favoring consistent scoring over lower latency.
/// favoring consistent scoring over lower latency. Can adversely affect performance.
///
/// Whether to use sticky sessions, which can help getting more consistent results.
/// When using sticky sessions, a best-effort attempt will be made to target the same replica set.
/// Be wary that reusing the same replica repeatedly can interfere with the load balancing of
/// the requests across replicas and adversely affect the performance of the search service.
///
/// See https://learn.microsoft.com/rest/api/searchservice/documents/search-post?view=rest-searchservice-2024-07-01&tabs=HTTP#request-body

Check failure on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Build (8.0.x, ubuntu-latest, Debug)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check failure on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Build (8.0.x, ubuntu-latest, Debug)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check warning on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Unit Tests (8.0.x, ubuntu-latest)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check warning on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Unit Tests (8.0.x, ubuntu-latest)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check failure on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Build (8.0.x, ubuntu-latest, Release)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check failure on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Build (8.0.x, ubuntu-latest, Release)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check warning on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Unit Tests (8.0.x, windows-latest)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'

Check warning on line 44 in extensions/AzureAISearch/AzureAISearch/AzureAISearchConfig.cs

View workflow job for this annotation

GitHub Actions / Unit Tests (8.0.x, windows-latest)

XML comment has badly formed XML -- 'Reference to undefined entity 'tabs'.'
/// </summary>
public bool UseSessionId { get; set; } = false;

Expand Down
13 changes: 12 additions & 1 deletion service/Service/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,18 @@
"APIKey": "",
// Hybrid search is not enabled by default. Note that when using hybrid search
// relevance scores are different, usually lower, than when using just vector search
"UseHybridSearch": false
"UseHybridSearch": false,
// Helps improve relevance score consistency for search services with multiple replicas by
// attempting to route a given request to the same replica for that session. Use this when
// favoring consistent scoring over lower latency. Can adversely affect performance.
//
// Whether to use sticky sessions, which can help getting more consistent results.
// When using sticky sessions, a best-effort attempt will be made to target the same replica set.
// Be wary that reusing the same replica repeatedly can interfere with the load balancing of
// the requests across replicas and adversely affect the performance of the search service.
//
// See https://learn.microsoft.com/rest/api/searchservice/documents/search-post?view=rest-searchservice-2024-07-01&tabs=HTTP#request-body
"UseSessionId": false
},
"AzureAIDocIntel": {
// "APIKey" or "AzureIdentity".
Expand Down
6 changes: 1 addition & 5 deletions service/tests/Core.FunctionalTests/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,7 @@
"Auth": "AzureIdentity",
"Endpoint": "https://<...>",
"APIKey": "",
"UseHybridSearch": false,
// Helps improve relevance score consistency for search services with multiple replicas by
// attempting to route a given request to the same replica for that session. Use this when
// favoring consistent scoring over lower latency.
"UseSessionId": false
"UseHybridSearch": false
},
"LlamaSharp": {
"TextModel": {
Expand Down

0 comments on commit 475e584

Please sign in to comment.