/mistral-observability | Type: Application | PCID required: Yes
Tools
mistral_observability_create_campaign_v1_observability_campaigns_post
Create and start a new campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | Yes | — | The description value |
judge_id | string | Yes | — | Judge Id |
max_nb_events | integer | Yes | — | Max Nb Events |
name | string | Yes | — | The name value |
search_params | object | Yes | — | Search Params |
mistral_observability_create_dataset_record_v1_observability_datasets_dataset_id_records_post
Add a conversation to the dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
payload | object | Yes | — | The payload value |
properties | object | Yes | — | The properties value |
mistral_observability_create_dataset_v1_observability_datasets_post
Create a new empty dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | Yes | — | The description value |
name | string | Yes | — | The name value |
mistral_observability_create_judge_v1_observability_judges_post
Create a new judge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | Yes | — | The description value |
instructions | string | Yes | — | The instructions value |
model_name | string | Yes | — | Model Name |
name | string | Yes | — | The name value |
output | object | Yes | — | The output value |
tools | string[] | Yes | — | The tools value |
mistral_observability_delete_campaign_v1_observability_campaigns_campaign_id_delete
Delete a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | Campaign Id |
mistral_observability_delete_dataset_record_v1_observability_dataset_records_dataset_record_id_delete
Delete a record from a dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_record_id | string | Yes | — | Dataset Record Id |
mistral_observability_delete_dataset_records_v1_observability_dataset_records_bulk_delete_post
Delete multiple records from datasets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_record_ids | string[] | Yes | — | Dataset Record Ids |
mistral_observability_delete_dataset_v1_observability_datasets_dataset_id_delete
Delete a dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
mistral_observability_delete_judge_v1_observability_judges_judge_id_delete
Delete a judge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
judge_id | string | Yes | — | Judge Id |
mistral_observability_export_dataset_to_jsonl_v1_observability_datasets_dataset_id_exports_to_jsonl_get
Export to the Files API and retrieve presigned URL to download the resulting JSONL file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
mistral_observability_get_campaign_by_id_v1_observability_campaigns_campaign_id_get
Get campaign by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | Campaign Id |
mistral_observability_get_campaign_selected_events_v1_observability_campaigns_campaign_id_selected_events_get
Get event ids that were selected by the given campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | Campaign Id |
page_size | integer | No | — | Number of results per page |
page | integer | No | — | Page number for pagination |
mistral_observability_get_campaign_status_by_id_v1_observability_campaigns_campaign_id_status_get
Get campaign status by campaign id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
campaign_id | string | Yes | — | Campaign Id |
mistral_observability_get_campaigns_v1_observability_campaigns_get
Get all campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page_size | integer | No | — | Number of results per page |
page | integer | No | — | Page number for pagination |
q | string | No | — | The q value |
mistral_observability_get_chat_completion_event_ids_v1_observability_chat_completion_events_search_ids_post
Alternative to /search that returns only the IDs and that can return many IDs at once Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
extra_fields | string[] | No | — | Extra Fields |
search_params | object | Yes | — | Search Params |
mistral_observability_get_chat_completion_event_v1_observability_chat_completion_events_event_id_get
Get Chat Completion Event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | string | Yes | — | Event Id |
mistral_observability_get_chat_completion_events_v1_observability_chat_completion_events_search_post
Get Chat Completion Events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page_size | integer | No | — | Number of results per page |
cursor | string | No | — | Pagination cursor from a previous response |
extra_fields | string[] | No | — | Extra Fields |
search_params | object | Yes | — | Search Params |
mistral_observability_get_chat_completion_field_options_counts_v1_observability_chat_completion_fields_field_name_options_counts_post
Get Chat Completion Field Options Counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_name | string | Yes | — | Field Name |
filter_params | object | No | — | Filter Params |
mistral_observability_get_chat_completion_field_options_v1_observability_chat_completion_fields_field_name_options_get
Get Chat Completion Field Options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_name | string | Yes | — | Field Name |
operator | string | Yes | — | The operator to use for filtering options |
mistral_observability_get_chat_completion_fields_v1_observability_chat_completion_fields_get
Get Chat Completion Fieldsmistral_observability_get_dataset_by_id_v1_observability_datasets_dataset_id_get
Get dataset by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
mistral_observability_get_dataset_import_task_v1_observability_datasets_dataset_id_tasks_task_id_get
Get status of a dataset import task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
task_id | string | Yes | — | Task Id |
mistral_observability_get_dataset_import_tasks_v1_observability_datasets_dataset_id_tasks_get
List import tasks for the given dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
page_size | integer | No | — | Number of results per page |
page | integer | No | — | Page number for pagination |
mistral_observability_get_dataset_record_v1_observability_dataset_records_dataset_record_id_get
Get the content of a given conversation from a dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_record_id | string | Yes | — | Dataset Record Id |
mistral_observability_get_dataset_records_v1_observability_datasets_dataset_id_records_get
List existing records in the dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
page_size | integer | No | — | Number of results per page |
page | integer | No | — | Page number for pagination |
mistral_observability_get_datasets_v1_observability_datasets_get
List existing datasets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page_size | integer | No | — | Number of results per page |
page | integer | No | — | Page number for pagination |
q | string | No | — | The q value |
mistral_observability_get_judge_by_id_v1_observability_judges_judge_id_get
Get judge by id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
judge_id | string | Yes | — | Judge Id |
mistral_observability_get_judges_v1_observability_judges_get
Get judges with optional filtering and search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type_filter | string[] | No | — | Filter by judge output types |
model_filter | string[] | No | — | Filter by model names |
page_size | integer | No | — | Number of results per page |
page | integer | No | — | Page number for pagination |
q | string | No | — | The q value |
mistral_observability_get_similar_chat_completion_events_v1_observability_chat_completion_events_event_id_similar_events_get
Get Similar Chat Completion Events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | string | Yes | — | Event Id |
mistral_observability_judge_chat_completion_event_v1_observability_chat_completion_events_event_id_live_judging_post
Run Judge on an event based on the given options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | string | Yes | — | Event Id |
judge_definition | object | Yes | — | Judge Definition |
mistral_observability_judge_conversation_v1_observability_judges_judge_id_live_judging_post
Run a saved judge on a conversation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
judge_id | string | Yes | — | Judge Id |
messages | object[] | Yes | — | The messages value |
properties | object | No | — | The properties value |
mistral_observability_judge_dataset_record_v1_observability_dataset_records_dataset_record_id_live_judging_post
Run Judge on a dataset record based on the given options Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_record_id | string | Yes | — | Dataset Record Id |
judge_definition | object | Yes | — | Judge Definition |
mistral_observability_post_dataset_records_from_campaign_v1_observability_datasets_dataset_id_imports_from_campaign_post
Populate the dataset with a campaign Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
campaign_id | string | Yes | — | Campaign Id |
mistral_observability_post_dataset_records_from_dataset_v1_observability_datasets_dataset_id_imports_from_dataset_post
Populate the dataset with samples from another dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
dataset_record_ids | string[] | Yes | — | Dataset Record Ids |
mistral_observability_post_dataset_records_from_explorer_v1_observability_datasets_dataset_id_imports_from_explorer_post
Populate the dataset with samples from the explorer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
completion_event_ids | string[] | Yes | — | Completion Event Ids |
mistral_observability_post_dataset_records_from_file_v1_observability_datasets_dataset_id_imports_from_file_post
Populate the dataset with samples from an uploaded file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
file_id | string | Yes | — | File Id |
mistral_observability_post_dataset_records_from_playground_v1_observability_datasets_dataset_id_imports_from_playground_post
Populate the dataset with samples from the playground Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
conversation_ids | string[] | Yes | — | Conversation Ids |
mistral_observability_update_dataset_record_payload_v1_observability_dataset_records_dataset_record_id_payload_put
Update a dataset record conversation payload Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_record_id | string | Yes | — | Dataset Record Id |
payload | object | Yes | — | The payload value |
mistral_observability_update_dataset_record_properties_v1_observability_dataset_records_dataset_record_id_properties_put
Update conversation properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_record_id | string | Yes | — | Dataset Record Id |
properties | object | Yes | — | The properties value |
mistral_observability_update_dataset_v1_observability_datasets_dataset_id_patch
Patch dataset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | Dataset Id |
description | string | No | — | The description value |
name | string | No | — | The name value |
mistral_observability_update_judge_v1_observability_judges_judge_id_put
Update a judge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
judge_id | string | Yes | — | Judge Id |
description | string | Yes | — | The description value |
instructions | string | Yes | — | The instructions value |
model_name | string | Yes | — | Model Name |
name | string | Yes | — | The name value |
output | object | Yes | — | The output value |
tools | string[] | Yes | — | The tools value |

