Skip to content

Clarifications in docs #392

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.

Sign up for GitHub

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

Merged
ppinchuk merged 3 commits into from
Mar 11, 2026
Merged

Clarifications in docs #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fac96f
Fix outdates keys
ppinchuk Mar 11, 2026
d169c21
Merge remote-tracking branch 'origin/main' into pp/fix_docs
ppinchuk Mar 11, 2026
b50bafd
More documentation updates
ppinchuk Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions compass/scripts/process.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,13 @@ async def process_jurisdictions_with_openai( # noqa: PLR0917, PLR0913
}
]

.. IMPORTANT::
You will need to ensure that the model name used here
matches your deployment if you are using Azure OpenAI. For
example, if you deployed the GPT-4o-mini model under the
name ``"gpt-4o-mini-2025-04-11"``, you would want to set
``"model": "gpt-4o-mini-2025-04-11"``.

By default, ``"gpt-4o"``.
num_urls_to_check_per_jurisdiction : int, optional
Number of unique Google search result URLs to check for each
Expand Down
7 changes: 7 additions & 0 deletions examples/execution_basics/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,13 @@ To override this default, add a ``model`` key to your config:
"model": "gpt-4o-mini"


.. IMPORTANT::
You will need to update the model name to match your deployment if you are using Azure OpenAI.
For example, if you deployed the GPT-4o-mini model under the name ``"gpt-4o-mini-2025-04-11"``,
you would set ``"model": "gpt-4o-mini-2025-04-11"`` in the COMPASS config (along with the
deployment endpoint, version, and API key).


Typical Config
--------------
In most cases, you'll want more control over the execution parameters, especially those related to the LLM configuration.
Expand Down
12 changes: 8 additions & 4 deletions examples/execution_basics/config_kitchen_sink.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"jurisdiction_fp": "jurisdictions.csv",
"model": [
{
// make sure the model name matches your Azure deployment model name!
"name": "deployment-gpt-4o-mini",
"llm_call_kwargs":{
"temperature": 0,
Expand All @@ -16,15 +17,16 @@
"text_splitter_chunk_overlap": 500,
"client_type": "azure", // this is the default
"client_kwargs": {
"azure_api_key": "<ADD AZURE OPENAI API KEY HERE>",
"azure_version": "<ADD AZURE OPENAI VERSION HERE>",
"api_key": "<ADD AZURE OPENAI API KEY HERE>",
"api_version": "<ADD AZURE OPENAI VERSION HERE>",
"azure_endpoint": "<ADD AZURE OPENAI ENDPOINT HERE>",
},
// "default" has to appear as a task exactly once across
// all models, or you will get an error
"tasks": "default",
},
{
// make sure the model name matches your Azure deployment model name!
"name": "deployment-gpt-4o",
"llm_call_kwargs":{
"temperature": 0,
Expand All @@ -36,8 +38,8 @@
"text_splitter_chunk_overlap": 1000,
"client_type": "azure", // this is the default
"client_kwargs": {
"azure_api_key": "<ADD AZURE OPENAI API KEY HERE>",
"azure_version": "<ADD AZURE OPENAI VERSION HERE>",
"api_key": "<ADD AZURE OPENAI API KEY HERE>",
"api_version": "<ADD AZURE OPENAI VERSION HERE>",
"azure_endpoint": "<ADD AZURE OPENAI ENDPOINT HERE>",
},
"tasks": [
Expand All @@ -48,6 +50,8 @@
]
},
{
// client type is "openai" below (not "azure"),
// so we use standard model names (not deployment-specific)
"name": "gpt-4o-mini",
"llm_call_kwargs":{
"temperature": 0,
Expand Down
7 changes: 4 additions & 3 deletions examples/execution_basics/config_recommended.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"jurisdiction_fp": "jurisdictions.csv",
"model": [
{
"name": "gpt-4o-mini",
// make sure the model name matches your Azure deployment model name!
"name": "deployment-gpt-4o-mini",
"llm_call_kwargs":{
"temperature": 0,
"timeout": 300
Expand All @@ -15,8 +16,8 @@
"text_splitter_chunk_overlap": 500,
"client_kwargs": {
// default client is Azure OpenAI
"azure_api_key": "<ADD AZURE OPENAI API KEY HERE>",
"azure_version": "<ADD AZURE OPENAI VERSION HERE>",
"api_key": "<ADD AZURE OPENAI API KEY HERE>",
"api_version": "<ADD AZURE OPENAI VERSION HERE>",
"azure_endpoint": "<ADD AZURE OPENAI ENDPOINT HERE>",
},
},
Expand Down
Loading