diff options
Diffstat (limited to 'help/RankingSolr_p.md')
| -rw-r--r-- | help/RankingSolr_p.md | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/help/RankingSolr_p.md b/help/RankingSolr_p.md new file mode 100644 index 000000000..4e4593c83 --- /dev/null +++ b/help/RankingSolr_p.md @@ -0,0 +1,96 @@ +--- +page: htroot/RankingSolr_p.html +help: help/RankingSolr_p.md +title: Solr Ranking Configuration +package: ranking-ai-analysis +access: admin +kind: admin-page +backend_java: source/net/yacy/htroot/RankingSolr_p.java +--- + +# Solr Ranking Configuration + +## Purpose + +Solr Ranking Configuration controls how Solr fields influence result order. + +Use it when the same documents are found but the order does not match the user's idea of relevance. + +## What You Can Do Here + +- Solr Ranking Configuration controls how Solr fields influence result order. +- Use representative queries or documents when evaluating changes. +- Change one model, field, weight, or threshold at a time so the effect can be explained. + +## Page Architecture + +Ranking and analysis pages expose the signals that influence result order or retrieval augmentation. The visible form usually maps directly to weights, model choices, field selections, or diagnostic thresholds. + +| Control | Meaning | Values or examples | +| --- | --- | --- | +| `profileNr` | boost= / bq= / fq=. | Text value; use the page label and surrounding context to choose the exact content. | +| `bf` | boost=. | Text value; use the page label and surrounding context to choose the exact content. | +| `EnterBF` | boost=. | `Set Boost Function` | +| `ResetBF` | boost=. | `Re-Set to default` | +| `bq` | bq=. | Text value; use the page label and surrounding context to choose the exact content. | +| `EnterBQ` | bq=. | `Set Boost Query` | +| `ResetBQ` | bq=. | `Re-Set to default` | +| `fq` | fq=. | Text value; use the page label and surrounding context to choose the exact content. | +| `EnterFQ` | fq=. | `Set Filter Query` | +| `ResetFQ` | fq=. | `Re-Set to default` | +| `#[field]#` | boost=. | boost= | +| `EnterBoosts` | boost=. | `Set Field Boosts` | +| `ResetBoosts` | boost=. | `Re-Set to default` | + +## Correct Use + +Use representative test queries or documents. Ranking, analysis, and AI settings are meaningful only when their effect can be compared. Keep notes about changed weights, model choices, fields, or thresholds. + +## Access And Safety + +Administrator access is required. YaCy protects `_p` pages as administration pages. + +Protected related endpoint(s): `/RankingSolr_p.html`. + +## Automation And API + +Page backend: `source/net/yacy/htroot/RankingSolr_p.java`. + +| Endpoint | Method | Access | Backend | +| --- | --- | --- | --- | +| `/RankingSolr_p.html` | `GET` | admin | `source/net/yacy/htroot/RankingSolr_p.java` | + +### Parameter Guide + +The table explains values that an agent or script must set deliberately. Parameters not relevant to a task should be omitted or left at the page default. Low-level generated parameters are omitted when they are only meaningful inside the rendered YaCy form. + +| Parameter | Meaning and valid values | Care | +| --- | --- | --- | +| `profileNr` | boost= / bq= / fq=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `bf` | boost=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `EnterBF` | boost=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `ResetBF` | boost=. | Changes stored data, configuration, or a running job. Use the authenticated action flow where required and verify the result. | +| `bq` | bq=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `EnterBQ` | bq=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `ResetBQ` | bq=. | Changes stored data, configuration, or a running job. Use the authenticated action flow where required and verify the result. | +| `fq` | fq=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `EnterFQ` | fq=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `ResetFQ` | fq=. | Changes stored data, configuration, or a running job. Use the authenticated action flow where required and verify the result. | +| `#[field]#` | boost=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `EnterBoosts` | boost=. | Set only when this option is part of the intended request; otherwise omit it and let YaCy use the page default. | +| `ResetBoosts` | boost=. | Changes stored data, configuration, or a running job. Use the authenticated action flow where required and verify the result. | + +Example request shape: + +```http +GET /RankingSolr_p.html?profileNr=...&bf=...&EnterBF=...&ResetBF=...&bq=... +``` + +## What To Expect + +Expect configuration values, diagnostics, or changed result behavior. The effect may only become visible after running the same query again, re-indexing fields, or using the configured model/RAG workflow. + +## Related Pages + +- `IndexSchema_p.html` +- `https://lucene.apache.org/solr/guide/6_6/function-queries.html` |