diff --git a/src/components/Sidebar.astro b/src/components/Sidebar.astro index 5bdc77a0..7f30287a 100644 --- a/src/components/Sidebar.astro +++ b/src/components/Sidebar.astro @@ -94,10 +94,10 @@ const isApiTab = activeTab?.tab === 'API'; function inferApiMethod(title: string): { method: string; css: string } | null { const t = title.toLowerCase(); - if (/\b(list|get|retrieve|health|find|export|progress|analytics|agreement)\b/.test(t)) { + if (/\b(list|get|retrieve|health|find|export|progress|analytics|agreement|compare|stats|summary|voices|tts)\b/.test(t)) { return { method: 'GET', css: 'api-method-get' }; } - if (/\b(create|add|generate|execute|submit|assign|bulk|complete|skip|release|pause|unpause|check|upload)\b/.test(t)) { + if (/\b(create|add|generate|execute|submit|assign|bulk|complete|skip|release|pause|unpause|check|upload|start|duplicate|fetch|run|rerun|cancel|clone|merge)\b/.test(t)) { return { method: 'POST', css: 'api-method-post' }; } if (/\b(delete|remove)\b/.test(t)) { diff --git a/src/components/docs/ApiCollapsible.astro b/src/components/docs/ApiCollapsible.astro index 957dcc84..b238d5ec 100644 --- a/src/components/docs/ApiCollapsible.astro +++ b/src/components/docs/ApiCollapsible.astro @@ -4,6 +4,7 @@ * * Used inside API reference pages to collapse nested object properties. * Renders as a pill/button that toggles visibility of child content. + * Supports nesting (collapsible inside collapsible). * * Usage: * @@ -15,15 +16,14 @@ interface Props { } const { title = 'Show properties' } = Astro.props; -const cid = `apic-${Math.random().toString(36).slice(2, 8)}`; --- -
- -
+
@@ -34,21 +34,33 @@ function initApiCollapsibles() { if (el._apicBound) return; el._apicBound = true; - var trigger = el.querySelector('[data-apic-trigger]'); - var icon = el.querySelector('[data-apic-icon]'); - var label = el.querySelector('[data-apic-label]'); + // Use direct children only — not nested collapsible triggers + var children = el.children; + var trigger = null; + var content = null; + for (var c = 0; c < children.length; c++) { + if (children[c].classList.contains('api-collapsible-trigger')) trigger = children[c]; + if (children[c].classList.contains('api-collapsible-content')) content = children[c]; + } + if (!trigger || !content) return; + + var icon = trigger.querySelector('.api-collapsible-icon'); + var label = trigger.querySelector('.api-collapsible-label'); var isOpen = false; var showTitle = label ? label.textContent : 'Show properties'; var hideTitle = showTitle.replace(/^Show\b/, 'Hide'); - if (trigger) { - trigger.addEventListener('click', function() { - isOpen = !isOpen; - el.classList.toggle('api-collapsible-open', isOpen); - if (icon) icon.textContent = isOpen ? '\u00d7' : '+'; - if (label) label.textContent = isOpen ? hideTitle : showTitle; - }); - } + trigger.addEventListener('click', function(e) { + e.stopPropagation(); + isOpen = !isOpen; + if (isOpen) { + content.style.display = 'block'; + } else { + content.style.display = 'none'; + } + if (icon) icon.textContent = isOpen ? '\u00d7' : '+'; + if (label) label.textContent = isOpen ? hideTitle : showTitle; + }); }); } initApiCollapsibles(); @@ -98,10 +110,6 @@ document.addEventListener('astro:page-load', initApiCollapsibles); flex-shrink: 0; } -.api-collapsible-open .api-collapsible-icon { - color: #a1a1aa; -} - .api-collapsible-label { font-size: 13px; font-weight: 500; @@ -111,8 +119,4 @@ document.addEventListener('astro:page-load', initApiCollapsibles); display: none; padding-top: 12px; } - -.api-collapsible-open .api-collapsible-content { - display: block; -} diff --git a/src/lib/api-navigation.ts b/src/lib/api-navigation.ts index 018fda23..59ac2f60 100644 --- a/src/lib/api-navigation.ts +++ b/src/lib/api-navigation.ts @@ -431,8 +431,25 @@ export const apiNavigation: ApiNavGroup[] = [ { "title": "Datasets", "items": [ + { "title": "Get Dataset", "href": "/docs/api/datasets/get-dataset", "method": "GET" }, + { "title": "List Datasets", "href": "/docs/api/datasets/list-datasets", "method": "GET" }, { "title": "Create Dataset", "href": "/docs/api/datasets/create-dataset", "method": "POST" }, - { "title": "Upload Dataset from File", "href": "/docs/api/datasets/upload-dataset", "method": "POST" } + { "title": "Create Empty Dataset", "href": "/docs/api/datasets/create-empty-dataset", "method": "POST" }, + { "title": "Upload Dataset from File", "href": "/docs/api/datasets/upload-dataset", "method": "POST" }, + { "title": "Create from HuggingFace", "href": "/docs/api/datasets/create-dataset-from-huggingface", "method": "POST" }, + { "title": "Clone Dataset", "href": "/docs/api/datasets/clone-dataset", "method": "POST" }, + { "title": "Duplicate Dataset", "href": "/docs/api/datasets/duplicate-dataset", "method": "POST" }, + { "title": "Add as New Dataset", "href": "/docs/api/datasets/add-as-new", "method": "POST" }, + { "title": "Update Dataset", "href": "/docs/api/datasets/update-dataset", "method": "POST" }, + { "title": "Merge Dataset", "href": "/docs/api/datasets/merge-dataset", "method": "POST" }, + { "title": "Delete Dataset", "href": "/docs/api/datasets/delete-dataset", "method": "DELETE" }, + { "title": "Add Rows from File", "href": "/docs/api/datasets/add-rows-from-file", "method": "POST" }, + { "title": "Add Empty Rows", "href": "/docs/api/datasets/add-empty-rows", "method": "POST" }, + { "title": "Add Rows from Existing", "href": "/docs/api/datasets/add-rows-from-existing", "method": "POST" }, + { "title": "Add Rows from HuggingFace", "href": "/docs/api/datasets/add-rows-from-huggingface", "method": "POST" }, + { "title": "Duplicate Rows", "href": "/docs/api/datasets/duplicate-rows", "method": "POST" }, + { "title": "Delete Rows", "href": "/docs/api/datasets/delete-rows", "method": "DELETE" }, + { "title": "Update Cell Value", "href": "/docs/api/datasets/update-cell-value", "method": "PUT" } ] }, { diff --git a/src/lib/navigation.ts b/src/lib/navigation.ts index a59133dd..b9a40e34 100644 --- a/src/lib/navigation.ts +++ b/src/lib/navigation.ts @@ -988,6 +988,20 @@ export const tabNavigation: NavTab[] = [ { title: 'Get Eval Log Details', href: '/docs/api/eval-logs-metrics/getevallogdetails' }, ] }, + { + title: 'Dataset Evals', + items: [ + { title: 'Get Eval Template Names', href: '/docs/api/dataset-evals/get-eval-template-names' }, + { title: 'Create Custom Eval Template', href: '/docs/api/dataset-evals/create-custom-eval-template' }, + { title: 'List Dataset Evals', href: '/docs/api/dataset-evals/list-dataset-evals' }, + { title: 'Get Eval Structure', href: '/docs/api/dataset-evals/get-eval-structure' }, + { title: 'Add Dataset Eval', href: '/docs/api/dataset-evals/add-dataset-eval' }, + { title: 'Start Evals Process', href: '/docs/api/dataset-evals/start-evals-process' }, + { title: 'Delete Dataset Eval', href: '/docs/api/dataset-evals/delete-dataset-eval' }, + { title: 'Edit and Run Eval', href: '/docs/api/dataset-evals/edit-and-run-eval' }, + { title: 'Get Eval Metrics', href: '/docs/api/dataset-evals/get-eval-metrics' }, + ] + }, { title: 'Scenarios', items: [ @@ -1091,8 +1105,59 @@ export const tabNavigation: NavTab[] = [ { title: 'Datasets', items: [ + { title: 'Get Dataset', href: '/docs/api/datasets/get-dataset' }, + { title: 'List Datasets', href: '/docs/api/datasets/list-datasets' }, { title: 'Create Dataset', href: '/docs/api/datasets/create-dataset' }, + { title: 'Create Empty Dataset', href: '/docs/api/datasets/create-empty-dataset' }, { title: 'Upload Dataset from File', href: '/docs/api/datasets/upload-dataset' }, + { title: 'Create from HuggingFace', href: '/docs/api/datasets/create-dataset-from-huggingface' }, + { title: 'Clone Dataset', href: '/docs/api/datasets/clone-dataset' }, + { title: 'Duplicate Dataset', href: '/docs/api/datasets/duplicate-dataset' }, + { title: 'Add as New Dataset', href: '/docs/api/datasets/add-as-new' }, + { title: 'Update Dataset', href: '/docs/api/datasets/update-dataset' }, + { title: 'Merge Dataset', href: '/docs/api/datasets/merge-dataset' }, + { title: 'Delete Dataset', href: '/docs/api/datasets/delete-dataset' }, + { title: 'Add Rows from File', href: '/docs/api/datasets/add-rows-from-file' }, + { title: 'Add Empty Rows', href: '/docs/api/datasets/add-empty-rows' }, + { title: 'Add Rows from Existing', href: '/docs/api/datasets/add-rows-from-existing' }, + { title: 'Add Rows from HuggingFace', href: '/docs/api/datasets/add-rows-from-huggingface' }, + { title: 'Duplicate Rows', href: '/docs/api/datasets/duplicate-rows' }, + { title: 'Delete Rows', href: '/docs/api/datasets/delete-rows' }, + { title: 'Update Cell Value', href: '/docs/api/datasets/update-cell-value' }, + ] + }, + { + title: 'Dataset Columns', + items: [ + { title: 'Get Column Details', href: '/docs/api/datasets/columns/get-column-details' }, + { title: 'Get Column Config', href: '/docs/api/datasets/columns/get-column-config' }, + { title: 'Add Static Column', href: '/docs/api/datasets/columns/add-static-column' }, + { title: 'Add Multiple Static Columns', href: '/docs/api/datasets/columns/add-multiple-static-columns' }, + { title: 'Add Columns', href: '/docs/api/datasets/columns/add-columns' }, + { title: 'Update Column Name', href: '/docs/api/datasets/columns/update-column-name' }, + { title: 'Update Column Type', href: '/docs/api/datasets/columns/update-column-type' }, + { title: 'Delete Column', href: '/docs/api/datasets/columns/delete-column' }, + ] + }, + { + title: 'Dataset Run Prompt', + items: [ + { title: 'Add Run Prompt Column', href: '/docs/api/datasets/run-prompt/add-run-prompt-column' }, + { title: 'Edit Run Prompt Column', href: '/docs/api/datasets/run-prompt/edit-run-prompt-column' }, + { title: 'Get Run Prompt Config', href: '/docs/api/datasets/run-prompt/retrieve-run-prompt-column-config' }, + { title: 'Get Run Prompt Options', href: '/docs/api/datasets/run-prompt/retrieve-run-prompt-options' }, + { title: 'Get Model Voices', href: '/docs/api/datasets/run-prompt/get-model-voices' }, + { title: 'TTS Voices', href: '/docs/api/datasets/run-prompt/tts-voices' }, + { title: 'Get Column Values', href: '/docs/api/datasets/run-prompt/get-column-values' }, + ] + }, + { + title: 'Dataset Analytics', + items: [ + { title: 'Run Prompt Stats', href: '/docs/api/datasets/analytics/run-prompt-stats' }, + { title: 'Eval Stats', href: '/docs/api/datasets/analytics/eval-stats' }, + { title: 'Annotation Summary', href: '/docs/api/datasets/analytics/annotation-summary' }, + { title: 'Explanation Summary', href: '/docs/api/datasets/analytics/explanation-summary' }, ] }, { diff --git a/src/pages/docs/api/dataset-evals/add-dataset-eval.mdx b/src/pages/docs/api/dataset-evals/add-dataset-eval.mdx new file mode 100644 index 00000000..57d143e9 --- /dev/null +++ b/src/pages/docs/api/dataset-evals/add-dataset-eval.mdx @@ -0,0 +1,134 @@ +--- +title: "Add Dataset Eval" +description: "Add an evaluation to a dataset by selecting a template and configuring the key mapping." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset to which the evaluation will be added. The dataset must exist within your organization and be accessible with your current API credentials. + + + + + + The human-readable name for the evaluation. Maximum 50 characters. This name is displayed in the dataset's eval sidebar and must be unique within the dataset for your organization. + + + + The universally unique identifier (UUID) of the eval template to use for this evaluation. Maximum 500 characters. The template defines the evaluation criteria, required variable keys, and output type. It must be accessible by your organization (either a built-in template or one you created). + + + + The configuration object that controls how the evaluation is executed against dataset rows. This includes template-specific settings, runtime parameters, and the variable-to-column mapping. + + + + Template-specific configuration parameters that customize the evaluation behavior. The available options depend on the eval template being used. + + + + Runtime parameters passed to the evaluation engine during processing. These may include thresholds, weights, or other execution-time settings. + + + + A key-value mapping that connects the eval template's variable keys to actual dataset column names. All required keys defined by the template must be present in this mapping. For example, `{"input": "question_column", "output": "response_column"}` maps the template's `input` variable to the `question_column` in the dataset. + + + + Whether to create an additional reason column alongside the eval result column. When `true`, the evaluation engine generates an explanation for each evaluation outcome, stored in a separate column. + + + + + + The universally unique identifier (UUID) of a knowledge base to associate with this evaluation. The knowledge base must exist within your organization and provides reference data that the evaluation can use to assess responses. + + + + Whether to enable error localization for this evaluation. When `true`, the evaluation engine identifies and highlights the specific portions of the output that caused evaluation failures. Default is `false`. + + + + The model to use for running the evaluation. Maximum 100 characters. This determines which LLM-based evaluation engine processes each row. Default is `turing_large`. + + + + Whether to immediately start running the evaluation after adding it to the dataset. When `true`, the eval column is created and all rows are queued for processing. When `false`, the evaluation is configured but not executed until explicitly triggered. Default is `false`. + + + + Whether to save this evaluation configuration as a new reusable eval template. When `true`, a new template is created with the provided `name`, which must be unique across all templates in your organization. Default is `false`. + + + + + + A confirmation message indicating the evaluation was successfully added to the dataset. Typically returns `success`. + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the evaluation is added without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the dataset does not belong to your organization; an eval with the same name already exists in the dataset; required mapping keys from the template are missing; the eval name does not meet naming requirements; the specified template does not exist or is not accessible; or `save_as_template` is `true` but the template name already exists. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found. Verify that the `dataset_id` in the path is correct and that your API credentials have access to the target dataset. + + + + Resource limit reached. Your organization has exceeded the evaluation addition quota. Contact support or upgrade your plan to increase limits. + + + + An unexpected error occurred on the server while adding the evaluation. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/create-custom-eval-template.mdx b/src/pages/docs/api/dataset-evals/create-custom-eval-template.mdx new file mode 100644 index 00000000..64eb5890 --- /dev/null +++ b/src/pages/docs/api/dataset-evals/create-custom-eval-template.mdx @@ -0,0 +1,136 @@ +--- +title: "Create Custom Eval Template" +description: "Create a custom evaluation template with criteria, output type, and model configuration." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The human-readable name for the eval template. Maximum 255 characters. This name is used to identify the template throughout the Future AGI platform and must be unique across both user-owned and system-owned templates. + + + + An optional description of what the eval template assesses and how it works. This description is displayed in the template selection UI to help users understand the purpose of the evaluation. + + + + The evaluation criteria text that the LLM evaluator uses to assess each row. Maximum 100,000 characters. Must contain at least one template variable using `{{variable_name}}` syntax (e.g., `{{input}}`, `{{output}}`). These variables are replaced with actual column values at evaluation time. + + + + The type of evaluation output produced by the template. Determines how evaluation results are categorized and displayed. Accepted values are `Pass/Fail` (binary pass or fail outcome, the default), `score` (numeric score), and `choices` (selection from predefined options). + + + + An array of template variable names that must be mapped to dataset columns when using this eval. These correspond to the `{{variable_name}}` placeholders in the criteria text. Every key listed here must be provided in the `mapping` object when the template is applied to a dataset. + + + + The configuration object controlling evaluation behavior and visibility settings. Only the following keys are allowed: `model`, `proxy_agi`, `visible_ui`, `reverse_output`, and `config`. + + + + The model to use for running evaluations with this template. Default is `turing_small`. This determines which LLM-based evaluation engine processes each row. + + + + Whether to route evaluation requests through the AGI proxy. Default is `true`. The proxy provides optimized routing and caching for evaluation workloads. + + + + Whether the eval template is visible in the Future AGI dashboard UI. Default is `true`. Set to `false` to hide the template from the template selection interface while keeping it available via the API. + + + + Whether to reverse the output logic of the evaluation. When `true`, the pass/fail or score interpretation is inverted. + + + + + + An optional array of tag strings used to categorize and filter the eval template. Tags help organize templates by domain, quality dimension, or use case (e.g., `["quality"]`, `["hallucination", "safety"]`). + + + + A key-value mapping of choice options. Required when `output_type` is `choices`. Each key represents a choice identifier and each value is the human-readable label for that choice (e.g., `{"A": "Good", "B": "Bad"}`). + + + + Whether the evaluation should check internet sources as part of its assessment process. When `true`, the evaluator can access external information to verify claims in the output. Default is `false`. + + + + Whether multiple choices can be selected simultaneously when `output_type` is `choices`. When `true`, the evaluation can select more than one option from the defined choices. Only relevant when `output_type` is `choices`. Default is `false`. + + + + The universally unique identifier (UUID) of an existing eval template to use as a base for creating the new template. When provided, the new template inherits settings from the specified template. + + + + + + The response payload containing the identifier of the newly created eval template. + + + + + The universally unique identifier (UUID) assigned to the newly created eval template. Use this ID to reference the template when adding evaluations to datasets or managing templates via the API. + + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the eval template is created without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: an eval template with the same name already exists; the `criteria` text does not contain at least one `{{variable}}` placeholder; the `choices` object is missing when `output_type` is `choices`; the `config` object contains keys other than `model`, `proxy_agi`, `visible_ui`, `reverse_output`, and `config`; or the template name does not meet naming requirements. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + An unexpected error occurred on the server while creating the eval template. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/delete-dataset-eval.mdx b/src/pages/docs/api/dataset-evals/delete-dataset-eval.mdx new file mode 100644 index 00000000..158cbc9d --- /dev/null +++ b/src/pages/docs/api/dataset-evals/delete-dataset-eval.mdx @@ -0,0 +1,72 @@ +--- +title: "Delete Dataset Eval" +description: "Remove an evaluation from a dataset, with an option to delete the associated column." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset containing the evaluation to delete. The dataset must exist within your organization and be accessible with your current API credentials. + + + + The universally unique identifier (UUID) of the user eval metric to delete. The evaluation must exist within the specified dataset and belong to your organization. + + + + + + Whether to permanently delete the eval's associated column and all its cell data. Default is `false`. When set to `true`, the eval column, reason column, and all associated cell data are soft-deleted, and the column is removed from the dataset's column order. This action cannot be undone. When set to `false`, the eval is hidden from the sidebar without deleting any underlying data, allowing it to be restored later. + + + + + + A human-readable confirmation message indicating that the evaluation was successfully deleted or hidden from the dataset. Typically returns `Eval deleted successfully`. + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the evaluation is deleted or hidden without errors. + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified evaluation was not found. It may not exist, may not belong to the specified dataset, or has already been deleted. Verify both the `dataset_id` and `eval_id` are correct. + + + + An unexpected error occurred on the server while deleting the evaluation. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/edit-and-run-eval.mdx b/src/pages/docs/api/dataset-evals/edit-and-run-eval.mdx new file mode 100644 index 00000000..ec85ce0b --- /dev/null +++ b/src/pages/docs/api/dataset-evals/edit-and-run-eval.mdx @@ -0,0 +1,129 @@ +--- +title: "Edit and Run Eval" +description: "Update an evaluation's configuration and optionally re-run it on the dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset containing the evaluation to edit. The dataset must exist within your organization and be accessible with your current API credentials. + + + + The universally unique identifier (UUID) of the user eval metric to update. The evaluation must exist within the specified dataset, belong to your organization, and not have been deleted. + + + + + + The updated configuration object for the evaluation. This controls how the evaluation is executed against dataset rows, including variable mapping and evaluation parameters. + + + + Template-specific configuration parameters that customize the evaluation behavior. The available options depend on the eval template associated with this evaluation. + + + + Runtime parameters passed to the evaluation engine during processing. These may include thresholds, weights, or other execution-time settings. + + + + A key-value mapping that connects the eval template's variable keys to actual dataset column names. All required keys defined by the template must be present in this mapping. For example, `{"input": "question_column", "output": "response_column"}`. + + + + Whether to create or keep an additional reason column alongside the eval result column. When `true`, the evaluation engine generates an explanation for each evaluation outcome. + + + + + + The universally unique identifier (UUID) of a knowledge base to associate with this evaluation. The knowledge base provides reference data that the evaluation can use to assess responses. + + + + Whether to enable error localization for this evaluation. When `true`, the evaluation engine identifies and highlights specific portions of the output that caused evaluation failures. + + + + The model to use for running the evaluation. This determines which LLM-based evaluation engine processes each row. + + + + Whether to re-run the evaluation after updating its configuration. When `true`, all cell statuses are reset to running and rows are queued for reprocessing. When `false`, only the configuration is updated without triggering execution. Default is `false`. + + + + Whether to save the updated configuration as a new reusable eval template. When `true`, the `name` field is required and must be unique across all templates. Default is `false`. + + + + The name for the new eval template. Required when `save_as_template` is `true`. Must be unique across all eval templates in your organization. + + + + + + A human-readable confirmation message indicating the evaluation configuration was successfully updated, and optionally that processing has been queued. Typically returns `Column evaluation updated and queued for processing`. + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the evaluation is updated without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the eval's associated column has been deleted; `save_as_template` is `true` but the template name already exists; the template name does not meet naming requirements; or required mapping keys from the template are missing. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified evaluation was not found. It may not exist, may not belong to the specified dataset, or has been deleted. Verify both the `dataset_id` and `eval_id` are correct. + + + + An unexpected error occurred on the server while updating or running the evaluation. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/get-eval-metrics.mdx b/src/pages/docs/api/dataset-evals/get-eval-metrics.mdx new file mode 100644 index 00000000..6a167e6e --- /dev/null +++ b/src/pages/docs/api/dataset-evals/get-eval-metrics.mdx @@ -0,0 +1,84 @@ +--- +title: "Get Eval Metrics" +description: "Retrieve evaluation metrics for a specific eval template with optional filtering." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the eval template whose aggregated metrics you want to retrieve. This endpoint also accepts this parameter as a query parameter for GET requests. + + + + An optional array of filter objects used to scope which evaluation results are included in the metrics calculation. Only results with `SUCCESS` status are considered. When empty or not provided, all successful results for the template are included. For GET requests, pass this as a JSON-encoded string in the `filters` query parameter. + + + + + + The aggregated evaluation metrics for the specified eval template. The exact structure depends on the eval template's output type and configuration, but commonly includes pass/fail rates, score distributions, or choice distributions. + + + + + The total number of evaluation results included in the metrics calculation, after applying any specified filters. Only results with `SUCCESS` status are counted. + + + + The proportion of evaluations that resulted in a pass outcome, expressed as a decimal between `0` and `1`. For example, `0.85` indicates that 85% of evaluated rows passed. Only present for `Pass/Fail` output type templates. + + + + The proportion of evaluations that resulted in a fail outcome, expressed as a decimal between `0` and `1`. This value is the complement of `pass_rate`. Only present for `Pass/Fail` output type templates. + + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when metrics are calculated without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: `eval_template_id` is missing; or the `filters` value could not be parsed as valid JSON. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + An unexpected error occurred on the server while calculating evaluation metrics. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/get-eval-structure.mdx b/src/pages/docs/api/dataset-evals/get-eval-structure.mdx new file mode 100644 index 00000000..0cbe60f3 --- /dev/null +++ b/src/pages/docs/api/dataset-evals/get-eval-structure.mdx @@ -0,0 +1,165 @@ +--- +title: "Get Eval Structure" +description: "Retrieve the configuration structure of a specific evaluation, including required keys, mapping, and model settings." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset. Required when `eval_type` is `user`, as the user eval is scoped to a specific dataset. For `preset` and `previously_configured` types, this parameter is still required in the URL path. + + + + The universally unique identifier (UUID) of the evaluation template or user eval metric whose structure you want to retrieve. The interpretation of this ID depends on the `eval_type` query parameter. + + + + + + The type of evaluation to retrieve the structure for. Accepted values are `preset` (a built-in eval template provided by Future AGI), `user` (a user-created eval configured on a specific dataset), and `previously_configured` (an eval template that has been previously configured on a dataset). This determines how the `eval_id` path parameter is interpreted and which data is returned. + + + + + + The response payload containing the full evaluation structure. + + + + + The evaluation structure object containing all configuration details needed to understand and use the evaluation. + + + + + The universally unique identifier (UUID) of the evaluation. For `user` type evals, this is the user eval metric ID; for `preset` type, this is the eval template ID. + + + + The universally unique identifier (UUID) of the underlying eval template that defines the evaluation criteria and output type. + + + + The human-readable display name of the evaluation, shown in the dataset's eval sidebar and template selection interfaces. + + + + A detailed description of what the evaluation assesses and how it works, helping users understand its purpose and applicability. + + + + An array of variable key names that must be mapped to dataset columns when configuring this evaluation. Every key in this list must have a corresponding entry in the `mapping` object. + + + + An array of variable key names that may optionally be mapped to dataset columns. These provide additional context to the evaluation but are not required for execution. + + + + The complete list of all template variable keys (both required and optional) recognized by this evaluation template. + + + + The current key-to-column mapping configuration. For `user` type evals, this reflects the configured mapping; for `preset` type, this is typically an empty object since no mapping has been configured yet. + + + + The eval configuration parameters specific to this template, including any template-specific settings that customize evaluation behavior. + + + + The runtime parameters for the evaluation, including thresholds, weights, or other execution-time settings. + + + + The output type of the evaluation. One of `Pass/Fail` (binary outcome), `score` (numeric score), or `choices` (selection from predefined options). + + + + The choice options for choice-type evaluations. Contains a key-value mapping of choice identifiers to labels (e.g., `{"A": "Good", "B": "Bad"}`). Returns `null` for non-choice output types. + + + + The available or configured model for running this evaluation (e.g., `turing_small`, `turing_large`). + + + + The universally unique identifier (UUID) of the associated knowledge base, if one is configured. Returns `null` when no knowledge base is associated. + + + + Whether error localization is enabled for this evaluation. When `true`, the evaluation engine identifies specific portions of output that caused failures. + + + + Whether the required API key for the evaluation model is configured in your organization's settings. When `false`, the evaluation cannot be run until the appropriate API key is added. + + + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the eval structure is retrieved without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: `eval_type` is missing or not one of the accepted values (`preset`, `user`, `previously_configured`); `dataset_id` is missing when `eval_type` is `user`; or the eval template has been updated since it was last configured. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified eval template or user eval was not found. Verify that the `eval_id` is correct and that the evaluation exists for the given `eval_type`. + + + + An unexpected error occurred on the server while retrieving the eval structure. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/get-eval-template-names.mdx b/src/pages/docs/api/dataset-evals/get-eval-template-names.mdx new file mode 100644 index 00000000..81c16c35 --- /dev/null +++ b/src/pages/docs/api/dataset-evals/get-eval-template-names.mdx @@ -0,0 +1,74 @@ +--- +title: "Get Eval Template Names" +description: "Search and retrieve a list of evaluation template names available in your organization." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + An optional text string used to filter eval template names. The search is case-insensitive and matches against template names. When empty or not provided, all eval templates accessible to your organization are returned. For example, searching `"hallucination"` returns all templates whose names contain that word. + + + + + + An array of eval template objects matching the search criteria. Each entry provides the essential identification and description information needed to select a template for use in dataset evaluations. + + + + + The universally unique identifier (UUID) of the eval template. Use this ID as the `template_id` when adding an evaluation to a dataset. + + + + The human-readable name of the eval template, used to identify it in the template selection interface and throughout the platform. + + + + A description of what the eval template assesses and how it works, helping users understand the purpose and applicability of the evaluation. + + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the template names are retrieved without errors. + + + + + + The request was malformed or an error occurred while processing the search query. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + diff --git a/src/pages/docs/api/dataset-evals/list-dataset-evals.mdx b/src/pages/docs/api/dataset-evals/list-dataset-evals.mdx new file mode 100644 index 00000000..640db736 --- /dev/null +++ b/src/pages/docs/api/dataset-evals/list-dataset-evals.mdx @@ -0,0 +1,137 @@ +--- +title: "List Dataset Evals" +description: "Retrieve a list of available evaluations for a dataset with filtering and search options." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset for which to retrieve the list of available evaluations. The dataset must exist within your organization and be accessible with your current API credentials. + + + + + + An optional text string to filter evaluations by name. The search is case-insensitive and returns evaluations whose names contain the specified text. + + + + Filter evaluations by their category. Accepted values are `futureagi_built` (built-in evaluations provided by Future AGI) and `user_built` (custom evaluations created by users in your organization). + + + + Filter evaluations by their type. Accepted values are `preset` (template-based evaluations not yet configured on this dataset), `user` (evaluations already configured and added to this dataset), and `previously_configured` (evaluation templates that have been used on this dataset before). + + + + An array of tag strings to filter evaluations by. Only evaluations tagged with at least one of the specified tags are returned. Pass multiple values to filter by multiple tags (e.g., `eval_tags[]=hallucination&eval_tags[]=quality`). + + + + An array of use case strings to filter evaluations by. Only evaluations associated with at least one of the specified use cases are returned. + + + + The universally unique identifier (UUID) of an experiment to scope the evaluation results to. When provided, the experiment must exist and belong to the specified dataset. This narrows the results to evaluations relevant to the given experiment context. + + + + The ordering mode for the returned evaluations. Use `simulate` for simulation-specific ordering that prioritizes evaluations relevant to simulation workflows. + + + + + + The response payload containing the list of evaluations and recommendations. + + + + + An array of evaluation objects matching the specified filters. Each evaluation includes its identification, description, and categorization metadata. + + + + + The universally unique identifier (UUID) of the evaluation. For `preset` types, this is the eval template ID; for `user` types, this is the user eval metric ID. + + + + The human-readable name of the evaluation, displayed in the eval selection interface and dataset sidebar. + + + + A description of what the evaluation assesses, helping users understand its purpose and decide whether to apply it to their dataset. + + + + An array of tag strings associated with the evaluation template, used for categorization and filtering (e.g., `["hallucination", "quality"]`). + + + + + An array of recommended evaluation category strings based on the dataset's content and structure. These suggestions help users discover relevant evaluations they may not have considered (e.g., `["Deterministic Evals"]`). + + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the evaluations list is retrieved without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: `dataset_id` is missing; or the specified `experiment_id` does not exist. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset does not exist. Verify the `dataset_id` in the path is correct and that your API credentials have access to the target dataset. + + + + An unexpected error occurred on the server while fetching the evaluations list. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/dataset-evals/start-evals-process.mdx b/src/pages/docs/api/dataset-evals/start-evals-process.mdx new file mode 100644 index 00000000..c79541ea --- /dev/null +++ b/src/pages/docs/api/dataset-evals/start-evals-process.mdx @@ -0,0 +1,67 @@ +--- +title: "Start Evals Process" +description: "Start running one or more evaluations on a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset on which to start the evaluation process. The dataset must exist within your organization and be accessible with your current API credentials. + + + + + + An array of user eval metric UUIDs identifying the evaluations to run. Must contain at least one ID. Each evaluation must exist within the specified dataset and belong to your organization, must not have been deleted, and must not have its associated column deleted (`column_deleted` must be `false`). The evaluation process creates the necessary columns and queues all rows for processing. + + + + + + A human-readable confirmation message indicating how many evaluations were started. Typically returns a message like `Successfully updated 2 eval(s) status`, where the number reflects the count of evaluations that were triggered. + + + + A boolean flag indicating whether the request completed successfully. Returns `true` when the evaluation process is started without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: `user_eval_ids` is empty; one or more evals have their associated column deleted and cannot be re-run; or one or more eval IDs do not exist, do not belong to the dataset, or have been deleted. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + An unexpected error occurred on the server while starting the evaluation process. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/add-as-new.mdx b/src/pages/docs/api/datasets/add-as-new.mdx new file mode 100644 index 00000000..9f7c39e4 --- /dev/null +++ b/src/pages/docs/api/datasets/add-as-new.mdx @@ -0,0 +1,72 @@ +--- +title: "Add as New Dataset" +description: "Create a new dataset from selected columns of an existing dataset or experiment." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the source dataset or experiment table from which columns and rows will be copied. The source must exist within your organization. All rows from the source dataset will be included in the new dataset, but only the columns specified in the `columns` mapping will be carried over. + + + The name for the newly created dataset. This name must be unique within your organization. Choose a descriptive name that helps identify the dataset's purpose or contents for easy reference later. + + + A JSON object that maps source column UUIDs to the desired column names in the new dataset. Each key is a UUID of a column in the source dataset, and each value is the string name that column should have in the new dataset. At least one column mapping is required, and no duplicate column names are allowed. Format: `{ "source_column_id": "new_column_name" }`. + + + + + + A human-readable confirmation message indicating the new dataset was created successfully, such as `"Dataset created successfully"`. + + + The universally unique identifier (UUID) of the newly created dataset. Use this ID to reference the dataset in subsequent API calls, such as adding rows, running evaluations, or retrieving dataset details. + + + + + + The request could not be processed. Possible reasons include: required fields (`dataset_id`, `name`, or `columns`) are missing, the column name mapping contains duplicate names, the columns mapping is empty, or a dataset with the specified name already exists in your organization. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The source dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + Resource limit reached. Your organization has exceeded the dataset creation or row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while creating the new dataset. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/add-empty-rows.mdx b/src/pages/docs/api/datasets/add-empty-rows.mdx new file mode 100644 index 00000000..2308d8ca --- /dev/null +++ b/src/pages/docs/api/datasets/add-empty-rows.mdx @@ -0,0 +1,68 @@ +--- +title: "Add Empty Rows" +description: "Add empty rows to an existing dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the target dataset to which empty rows will be appended. The dataset must exist within your organization and can have any number of existing columns and rows. + + + + + + The number of empty rows to add to the dataset. Each new row will have blank values for all existing columns. The value must be an integer between 1 and 100, inclusive. Use this to pre-allocate rows that you intend to populate later via the Update Cell Value endpoint or through the dashboard. + + + + + + A human-readable confirmation message indicating how many empty rows were successfully added to the dataset, such as `"Successfully added 5 empty row(s)"`. + + + Indicates the outcome of the API request. Returns `"success"` when the empty rows are added without errors. + + + + + + The request could not be processed. Possible reasons include: the `num_rows` field is missing, the value is not a valid integer, or the value is outside the allowed range of 1 to 100. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The specified dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + Resource limit reached. Your organization has exceeded the row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while adding empty rows. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/add-rows-from-existing.mdx b/src/pages/docs/api/datasets/add-rows-from-existing.mdx new file mode 100644 index 00000000..60dd466c --- /dev/null +++ b/src/pages/docs/api/datasets/add-rows-from-existing.mdx @@ -0,0 +1,86 @@ +--- +title: "Add Rows from Existing Dataset" +description: "Add rows from one dataset to another using column mapping." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the target dataset that will receive the imported rows. This dataset must exist within your organization and must be different from the source dataset. + + + + + + The universally unique identifier (UUID) of the source dataset from which rows will be copied. The source dataset must belong to your organization and cannot be the same as the target dataset specified in the path parameter. + + + A JSON object that defines how columns from the source dataset map to columns in the target dataset. Each key is a source column UUID and each value is the corresponding target column UUID. At least one mapping entry is required, and no duplicate target column UUIDs are allowed. Only rows with data in the mapped columns will be imported. Format: `{ "source_column_id": "target_column_id" }`. + + + + + + The response payload containing details about the completed row import operation. + + + + A human-readable confirmation message indicating the rows were imported successfully, such as `"Rows Imported successfully"`. + + + The total number of rows that were successfully copied from the source dataset into the target dataset during this import operation. + + + + Indicates the outcome of the API request. Returns `"success"` when the row import completes without errors. + + + + + + The request could not be processed. Possible reasons include: the source and target datasets are the same, the column mapping is empty, the column mapping contains duplicate target columns, or no valid column mappings were found (check that the column IDs exist in their respective datasets). + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The source or target dataset could not be found. Confirm that both dataset UUIDs are valid and belong to your organization. + + + Resource limit reached. Your organization has exceeded the row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while processing the row import. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/add-rows-from-file.mdx b/src/pages/docs/api/datasets/add-rows-from-file.mdx new file mode 100644 index 00000000..1873fe3f --- /dev/null +++ b/src/pages/docs/api/datasets/add-rows-from-file.mdx @@ -0,0 +1,66 @@ +--- +title: "Add Rows from File" +description: "Add rows to an existing dataset by uploading a file." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The file to upload containing the row data to be added to the dataset. Supported formats include `.csv`, `.xls`, `.xlsx`, `.json`, and `.jsonl`. The maximum allowed file size is 10 MB. The request must use `multipart/form-data` content type when uploading this field. Column headers in the file are matched to existing dataset columns by name. + + + The universally unique identifier (UUID) of the target dataset to which the uploaded rows will be added. The dataset must exist within your organization and must have columns that correspond to the file's column headers or keys. + + + + + + A human-readable confirmation message indicating how many rows were successfully added from the uploaded file, such as `"50 Row(s) added successfully"`. + + + Indicates the outcome of the API request. Returns `"success"` when the file upload and row import completes without errors. + + + + + + The request could not be processed. Possible reasons include: no file was uploaded, the file exceeds the 10 MB size limit, the file format is not supported (only `.csv`, `.xls`, `.xlsx`, `.json`, `.jsonl`), the `dataset_id` field is missing, or the file could not be parsed. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The specified dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + Resource limit reached. Your organization has exceeded the row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while processing the file upload. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/add-rows-from-huggingface.mdx b/src/pages/docs/api/datasets/add-rows-from-huggingface.mdx new file mode 100644 index 00000000..5fc0b4af --- /dev/null +++ b/src/pages/docs/api/datasets/add-rows-from-huggingface.mdx @@ -0,0 +1,87 @@ +--- +title: "Add Rows from HuggingFace" +description: "Add rows to an existing dataset by importing from a HuggingFace dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the target dataset that will receive the imported rows from HuggingFace. The dataset must exist within your organization. New columns will be created in the target dataset to match the schema of the imported HuggingFace data. + + + + + + The full path or name of the HuggingFace dataset to import from. This can be a simple dataset name like `"squad"` or `"glue"`, or a namespaced path like `"username/dataset-name"`. The dataset must be publicly accessible on the HuggingFace Hub. + + + The specific configuration or subset of the HuggingFace dataset to use. Many HuggingFace datasets have multiple configurations (e.g., `"plain_text"` for SQuAD, `"mnli"` for GLUE). This value must match an available configuration for the specified dataset. + + + The dataset split to import rows from. Common values include `"train"`, `"test"`, and `"validation"`. The split must exist within the specified dataset configuration. + + + The maximum number of rows to import from the HuggingFace dataset split. If this field is omitted or not provided, all rows from the specified split will be imported. Use this to limit the import size when working with large datasets. + + + + + + The response payload containing details about the completed HuggingFace import operation. + + + + A human-readable confirmation message indicating how many rows were successfully imported from HuggingFace, such as `"50 Row(s) imported Successfully"`. + + + + Indicates the outcome of the API request. Returns `"success"` when the HuggingFace import completes without errors. + + + + + + The request could not be processed. Possible reasons include: the `huggingface_dataset_config` or `huggingface_dataset_split` fields are missing, the HuggingFace dataset could not be found or accessed, or the specified configuration or split does not exist for the given dataset. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The target dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + Resource limit reached. Your organization has exceeded the row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while processing the HuggingFace import. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/analytics/annotation-summary.mdx b/src/pages/docs/api/datasets/analytics/annotation-summary.mdx new file mode 100644 index 00000000..db91525e --- /dev/null +++ b/src/pages/docs/api/datasets/analytics/annotation-summary.mdx @@ -0,0 +1,106 @@ +--- +title: "Annotation Summary" +description: "Get a summary of annotations for a dataset, including label distributions and annotator statistics." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset for which you want to retrieve the annotation summary. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + A status message indicating the result of the request. Returns `success` when the annotation summary is retrieved successfully. + + + + The aggregated annotation summary for the dataset, including overall progress metrics and the distribution of annotation labels applied across all rows. + + + + The total number of individual annotations that have been applied across all rows in the dataset. A single row may have multiple annotations if reviewed by multiple annotators or annotated multiple times. + + + The total number of rows in the dataset, regardless of whether they have been annotated. This provides the denominator for calculating annotation coverage. + + + The number of rows in the dataset that have received at least one annotation. Combined with `total_rows`, this indicates how much of the dataset has been reviewed. + + + The ratio of annotated rows to total rows, expressed as a decimal between 0 and 1. Calculated as `annotated_rows / total_rows`. Provides a quick measure of how complete the annotation effort is for this dataset. + + + A breakdown of annotation labels applied across the dataset, showing the distribution of each label. Useful for understanding the balance of categories in your annotated data. + + + + The display name of the annotation label as defined in your annotation configuration. Examples include `Correct`, `Incorrect`, `Partially Correct`, or any custom labels you have configured. + + + The total number of times this specific label has been applied across all annotations in the dataset. + + + The proportion of total annotations that used this label, expressed as a decimal between 0 and 1. Calculated as `count / total_annotations`. + + + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/analytics/eval-stats.mdx b/src/pages/docs/api/datasets/analytics/eval-stats.mdx new file mode 100644 index 00000000..3073b03e --- /dev/null +++ b/src/pages/docs/api/datasets/analytics/eval-stats.mdx @@ -0,0 +1,106 @@ +--- +title: "Eval Stats" +description: "Get evaluation statistics for a dataset, including metrics by column." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset for which you want to retrieve evaluation statistics. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + A comma-separated list of evaluation column UUIDs to filter the returned statistics. When provided, only statistics for the specified columns are included in the response. When omitted, statistics for all evaluation columns in the dataset are returned. + + + + + Returns an array of evaluation statistics objects, one per evaluation template applied to the dataset. Each object provides aggregated metrics summarizing the evaluation results. + + + The name of the evaluation template that produced these metrics. This corresponds to the template configured on the evaluation column, such as `Relevance`, `Faithfulness`, `Coherence`, or a custom template name. + + + + The total number of data points (rows) that were evaluated by this template. This count includes both passed and failed evaluations. + + + + The arithmetic mean of all evaluation scores produced by this template across the dataset. Scores are typically normalized to a 0-to-1 range, where higher values indicate better performance. + + + + The lowest evaluation score recorded for this template across all evaluated rows in the dataset. Useful for identifying worst-case performance. + + + + The highest evaluation score recorded for this template across all evaluated rows in the dataset. Useful for understanding the upper bound of performance. + + + + The number of evaluated rows that met or exceeded the passing threshold defined by the evaluation template. Combined with `fail_count`, this accounts for all evaluated rows. + + + + The number of evaluated rows that fell below the passing threshold defined by the evaluation template. Indicates how many data points did not meet the quality criteria. + + + + The ratio of passed evaluations to total evaluations, expressed as a decimal between 0 and 1. Calculated as `pass_count / metric_count`. Provides a quick summary of overall evaluation quality. + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/analytics/explanation-summary.mdx b/src/pages/docs/api/datasets/analytics/explanation-summary.mdx new file mode 100644 index 00000000..6f27343e --- /dev/null +++ b/src/pages/docs/api/datasets/analytics/explanation-summary.mdx @@ -0,0 +1,94 @@ +--- +title: "Explanation Summary" +description: "Get an AI-generated explanation summary for a dataset's content and patterns." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset for which you want to retrieve or generate an AI-powered explanation summary. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. If no summary has been generated yet, calling this endpoint automatically triggers a background generation task. + + + + + + A status message indicating the result of the request. Returns `success` when the explanation summary data is retrieved, regardless of whether the summary itself has been generated yet. + + + + The explanation summary data and generation status. The `response` field contains the actual summary content when available, while the `status` field indicates whether the summary has been generated, is in progress, or cannot be generated due to insufficient data. + + + + The AI-generated explanation summary content. Contains structured insights about the dataset's content, patterns, and potential issues. Returns `null` if the summary has not yet been generated or if the dataset has insufficient data. + + + + A comprehensive natural-language summary describing the dataset's content, structure, and overall characteristics. Provides a high-level overview of what the data represents and its key attributes. + + + A list of notable patterns, trends, and correlations identified by the AI analysis across the dataset's rows and columns. Each entry is a string describing a specific observation. + + + A list of potential quality issues, anomalies, or concerns identified in the dataset. Each entry is a string describing a specific issue that may require attention, such as data inconsistencies, hallucinations, or coverage gaps. + + + + The ISO 8601 timestamp indicating when the explanation summary was last generated or refreshed. Returns `null` if the summary has never been generated. + + + The current generation status of the explanation summary. Possible values: `COMPLETED` indicates the summary is available and ready to read; `PENDING` indicates the summary generation is currently in progress as a background task; `INSUFFICIENT_DATA` indicates the dataset does not have enough rows to generate a meaningful summary. + + + The current number of rows in the dataset at the time of the request. Used in conjunction with `min_rows_required` to determine whether the dataset has sufficient data for summary generation. + + + The minimum number of rows required in the dataset before an explanation summary can be generated. If `row_count` is less than this value, the status will be `INSUFFICIENT_DATA`. + + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/analytics/run-prompt-stats.mdx b/src/pages/docs/api/datasets/analytics/run-prompt-stats.mdx new file mode 100644 index 00000000..6eb3d3ee --- /dev/null +++ b/src/pages/docs/api/datasets/analytics/run-prompt-stats.mdx @@ -0,0 +1,122 @@ +--- +title: "Run Prompt Stats" +description: "Get aggregated statistics for run prompt columns in a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset for which you want to retrieve run prompt statistics. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + A comma-separated list of RunPrompter UUIDs to filter the returned statistics. When provided, only statistics for the specified run prompt columns are included in the response. When omitted, statistics for all run prompt columns in the dataset are returned. + + + + + + A status message indicating the result of the request. Returns `success` when the statistics are retrieved successfully. + + + + The aggregated run prompt statistics for the dataset, including overall averages and per-prompt breakdowns. + + + + The average number of tokens consumed per prompt execution across all run prompt columns in the dataset. This includes both input and output tokens and provides an overall measure of token usage efficiency. + + + The average cost in USD per prompt execution across all run prompt columns in the dataset. Calculated based on the model pricing for the tokens consumed during each execution. + + + The average response time in seconds per prompt execution across all run prompt columns in the dataset. Measures the end-to-end latency from sending the prompt to receiving the complete response from the language model. + + + A detailed per-prompt breakdown of execution statistics. Each object in the array represents a single run prompt column and its individual performance metrics. + + + + The universally unique identifier (UUID) of the RunPrompter configuration associated with this run prompt column. + + + The human-readable name of the run prompt column as it appears in the dataset grid. + + + The identifier of the language model used for prompt execution in this column, such as `gpt-4o`, `gpt-3.5-turbo`, or `claude-3-opus`. + + + The average number of tokens consumed per execution for this specific run prompt column. + + + The average cost in USD per execution for this specific run prompt column. + + + The average response time in seconds per execution for this specific run prompt column. + + + The total number of rows in the dataset that this run prompt column was configured to process. + + + The number of rows that were successfully processed by this run prompt column, producing a valid output. + + + The number of rows where prompt execution failed for this column, due to errors such as model timeouts, rate limits, or invalid input data. + + + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/clone-dataset.mdx b/src/pages/docs/api/datasets/clone-dataset.mdx new file mode 100644 index 00000000..20f00ab7 --- /dev/null +++ b/src/pages/docs/api/datasets/clone-dataset.mdx @@ -0,0 +1,80 @@ +--- +title: "Clone Dataset" +description: "Create a copy of an existing dataset with all its columns and rows." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the source dataset to clone. The clone operation creates a full copy of all user-created columns and all rows from this dataset into a new, independent dataset. + + + + + + The human-readable name to assign to the cloned dataset. This name is used to identify the new dataset throughout the Future AGI platform. If not provided, the name defaults to `Copy of {source_dataset_name}`. Must be unique within your organization. + + + + + + A human-readable confirmation message indicating that the dataset was cloned successfully. Typically returns `Dataset cloned successfully`. + + + + The universally unique identifier (UUID) assigned to the newly cloned dataset. Use this ID to reference the cloned dataset in subsequent API calls such as updating, adding rows, or running evaluations. + + + + The name assigned to the cloned dataset, either matching the `new_dataset_name` value provided in the request body or the auto-generated default name. + + + + + + The request was malformed or contained invalid parameters. This can occur when a dataset with the specified name already exists in your organization. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The source dataset could not be found. The provided ID does not match any dataset in your organization. Verify the dataset UUID is correct and that the dataset has not been deleted. + + + + Resource limit reached. Your organization has exceeded the dataset creation or row addition quota. Contact support or upgrade your plan to increase limits. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/add-columns.mdx b/src/pages/docs/api/datasets/columns/add-columns.mdx new file mode 100644 index 00000000..ba58b204 --- /dev/null +++ b/src/pages/docs/api/datasets/columns/add-columns.mdx @@ -0,0 +1,105 @@ +--- +title: "Add Columns" +description: "Add one or more columns to a dataset with specified names and data types." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset you want to add columns to. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + An array of column definition objects specifying the columns to create. Each object describes a single column to be added to the dataset. All columns in the array are created in a single operation, and each column receives a unique system-generated UUID upon creation. + + + The human-readable name to assign to the new column. This name is used to identify the column throughout the Future AGI platform, including in the dataset grid, evaluation configurations, and prompt templates. Must be unique within the dataset. + + + The data type for the column, which determines what kind of values can be stored in it and how the platform renders and validates cell contents. Valid values: `text`, `number`, `boolean`, `json`, `image`, `audio`, `pdf`. + + + An optional source type annotation for the column. When specified, this indicates the origin or intended purpose of the column data, which can be used by the platform for downstream processing and filtering. + + + + + + + + A human-readable confirmation message indicating the number of columns that were successfully added. Typically returns a string like `2 Columns added successfully`. + + + + An array of the newly created column objects. Each object contains the system-generated UUID and the column metadata that was provided in the request. + + + + The universally unique identifier (UUID) assigned to the newly created column. Use this ID to reference the column in subsequent API calls such as updating, deleting, or configuring the column. + + + The human-readable name of the column as specified in the request. + + + The data type of the column as specified in the request. One of: `text`, `number`, `boolean`, `json`, `image`, `audio`, `pdf`. + + + + + + + The request was malformed or contained invalid parameters. This can occur when: `new_columns_data` is not a valid array; individual column objects are missing the required `name` or `data_type` fields; a column with the same name already exists in the dataset; or the specified `data_type` is not one of the supported values. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/add-multiple-static-columns.mdx b/src/pages/docs/api/datasets/columns/add-multiple-static-columns.mdx new file mode 100644 index 00000000..d771ede0 --- /dev/null +++ b/src/pages/docs/api/datasets/columns/add-multiple-static-columns.mdx @@ -0,0 +1,78 @@ +--- +title: "Add Multiple Static Columns" +description: "Add multiple static columns to a dataset in a single request." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset to which you want to add multiple static columns. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + An array of column definition objects to add to the dataset in a single atomic operation. All columns are created together -- if any column fails validation, none are added. Each object describes a single static column to be created. + + + The human-readable name to assign to the new column. This name is used to identify the column throughout the Future AGI platform, including in the dataset grid, evaluation configurations, and prompt template variable mappings. Must be unique within both the dataset and the request itself. + + + The data type for the column, which determines what kind of values can be stored in it and how the platform renders and validates cell contents. Valid values: `text`, `number`, `boolean`, `json`, `image`, `audio`, `pdf`. + + + An optional source type annotation for the column. When specified, this indicates the origin or intended purpose of the column data, which can be used by the platform for downstream processing and filtering. + + + + + + + + A human-readable confirmation message indicating the number of columns that were successfully added. Empty cells are automatically initialized for each new column across all existing rows in the dataset. Typically returns a string like `3 columns added successfully`. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `columns` array is empty or missing; individual column objects are missing the required `new_column_name` or `column_type` fields; column names within the request are not unique; a column with one of the provided names already exists in the dataset; or one or more `column_type` values are not supported. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/add-static-column.mdx b/src/pages/docs/api/datasets/columns/add-static-column.mdx new file mode 100644 index 00000000..e8ee4ca1 --- /dev/null +++ b/src/pages/docs/api/datasets/columns/add-static-column.mdx @@ -0,0 +1,73 @@ +--- +title: "Add Static Column" +description: "Add a single static column to an existing dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset to which you want to add a static column. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + The human-readable name to assign to the new static column. This name is used to identify the column throughout the Future AGI platform, including in the dataset grid, evaluation configurations, and prompt template variable mappings. Must be unique within the dataset. + + + + The data type for the new column, which determines what kind of values can be stored in it and how the platform renders and validates cell contents. Valid values: `text`, `number`, `boolean`, `json`, `image`, `audio`, `pdf`. + + + + An optional source type annotation for the column. When specified, this indicates the origin or intended purpose of the column data, which can be used by the platform for downstream processing and filtering. + + + + + + A human-readable confirmation message indicating that the column was created successfully. Empty cells are automatically initialized for all existing rows in the dataset. Typically returns `Column added successfully`. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `new_column_name` field is missing or empty; the `column_type` field is missing; a column with the same name already exists in the dataset; or the provided `column_type` is not one of the supported data type values. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/delete-column.mdx b/src/pages/docs/api/datasets/columns/delete-column.mdx new file mode 100644 index 00000000..46804b36 --- /dev/null +++ b/src/pages/docs/api/datasets/columns/delete-column.mdx @@ -0,0 +1,54 @@ +--- +title: "Delete Column" +description: "Delete a column and its associated data from a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset that contains the column you want to delete. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + The universally unique identifier (UUID) of the column to delete. This ID is returned when a column is created and can be retrieved from the column details endpoint. Deleting a column permanently removes all cell data associated with it, removes the column from the dataset's column order, and deletes any linked configurations such as run prompt or evaluation settings. + + + + + + A human-readable confirmation message indicating that the column and all of its associated data were successfully deleted. The following cleanup is performed automatically: all cell data in the column is removed, the column is removed from the dataset's column ordering, and if the column had a source type (such as RUN_PROMPT or EVALUATION), the associated configuration is also deleted. Typically returns `Column deleted successfully`. + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified column or dataset was not found, or does not belong to your organization. Verify that both the `dataset_id` and `column_id` are correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/get-column-config.mdx b/src/pages/docs/api/datasets/columns/get-column-config.mdx new file mode 100644 index 00000000..944e6c67 --- /dev/null +++ b/src/pages/docs/api/datasets/columns/get-column-config.mdx @@ -0,0 +1,157 @@ +--- +title: "Get Column Config" +description: "Retrieve the configuration details for a specific column, including source-specific settings." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the column whose configuration you want to retrieve. This ID is returned when a column is created and can be retrieved from the column details endpoint. The response structure varies depending on the column's source type. + + + + + The response structure depends on the column's source type. Below are the fields returned for each source type. + + + The human-readable name assigned to the column. Present in all source types. + + + + The identifier of the language model used for prompt execution. Only present for RUN_PROMPT source columns. Examples include `gpt-4o`, `gpt-3.5-turbo`, `claude-3-opus`, etc. + + + + The ordered list of chat messages that define the prompt template sent to the language model. Each message object contains a `role` (such as `system`, `user`, or `assistant`) and `content` (the message text, which may include template variables in double-brace syntax like `{{input}}`). Present for RUN_PROMPT and OPTIMISATION source columns. + + + + The expected output format for the language model response. Common values include `string` for plain text output and `json` for structured JSON output. Only present for RUN_PROMPT source columns. + + + + The sampling temperature parameter used when generating model responses. A value between 0 and 2, where lower values produce more deterministic output and higher values produce more creative output. Only present for RUN_PROMPT source columns. + + + + The frequency penalty parameter applied during model response generation. A value between -2.0 and 2.0 that penalizes new tokens based on their existing frequency in the text so far, reducing the likelihood of repeating the same content. Only present for RUN_PROMPT source columns. + + + + The presence penalty parameter applied during model response generation. A value between -2.0 and 2.0 that penalizes new tokens based on whether they appear in the text so far, encouraging the model to discuss new topics. Only present for RUN_PROMPT source columns. + + + + The maximum number of tokens the model is allowed to generate in a single response. Controls the length of the output. Only present for RUN_PROMPT source columns. + + + + The nucleus sampling parameter. A value between 0 and 1 that controls the cumulative probability threshold for token selection. Lower values make the output more focused and deterministic. Only present for RUN_PROMPT source columns. + + + + An optional structured output format specification for the model response. When set, it constrains the model to produce output matching a specific schema. Can be `null` if no format constraint is applied. Only present for RUN_PROMPT source columns. + + + + Controls which tool (if any) the model should use. Can be `null` if no tool usage is configured. Only present for RUN_PROMPT source columns. + + + + A list of tool definitions available to the model during prompt execution. Each tool describes a function the model can call. Returns an empty array if no tools are configured. Only present for RUN_PROMPT source columns. + + + + The name of the evaluation template used by this column. Only present for EVALUATION source columns. + + + + The configuration parameters specific to the evaluation template. Only present for EVALUATION source columns. + + + + A human-readable description of what the evaluation measures. Only present for EVALUATION source columns. + + + + Additional configuration settings for the evaluation. Only present for EVALUATION source columns. + + + + The current execution status of the column. Values include `COMPLETED`, `RUNNING`, `PENDING`, or `FAILED`. Present for EVALUATION, EXPERIMENT, and OPTIMISATION source columns. + + + + The prompt configuration used for the experiment. Only present for EXPERIMENT source columns. + + + + A list of evaluation template UUIDs linked to this column for automated evaluation. Present for EXPERIMENT and OPTIMISATION source columns. + + + + The type of optimization being performed. Only present for OPTIMISATION source columns. + + + + The number of optimized prompt variations generated. Only present for OPTIMISATION source columns. + + + + The model configuration settings used during optimization, including model name, temperature, and other parameters. Only present for OPTIMISATION source columns. + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified column was not found or does not belong to your organization. Verify that the `column_id` is correct and that you have access to the associated dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/get-column-details.mdx b/src/pages/docs/api/datasets/columns/get-column-details.mdx new file mode 100644 index 00000000..8ebb6f9c --- /dev/null +++ b/src/pages/docs/api/datasets/columns/get-column-details.mdx @@ -0,0 +1,95 @@ +--- +title: "Get Column Details" +description: "Retrieve column metadata for a dataset, including column names, types, and IDs." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset whose column metadata you want to retrieve. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + + + + Whether to include columns with RUN_PROMPT source type in the response. By default, RUN_PROMPT columns are excluded from the results. Set to `true` to include them alongside static and other column types. + + + + Filter the returned columns by their source type. When specified, only columns matching the given source are returned. Common values include `STATIC` for manually created columns, `RUN_PROMPT` for prompt-generated columns, and `EVALUATION` for evaluation metric columns. + + + + + + A status message indicating the result of the request. Returns `success` when the column details are retrieved successfully. + + + + The response payload containing the column configuration for the specified dataset. + + + + An ordered list of column metadata objects representing all columns in the dataset that match the applied filters. Each object provides the essential identifiers and type information for a single column. + + + + The universally unique identifier (UUID) assigned to the column. Use this ID to reference the column in subsequent API calls such as updating column names, changing column types, or deleting columns. + + + The human-readable name of the column as it appears in the dataset grid and throughout the platform. + + + The data type of the column, which determines what kind of values can be stored in it. One of: `text`, `number`, `boolean`, `json`, `image`, `audio`, `pdf`. + + + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify that the `dataset_id` is correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/update-column-name.mdx b/src/pages/docs/api/datasets/columns/update-column-name.mdx new file mode 100644 index 00000000..32618a0c --- /dev/null +++ b/src/pages/docs/api/datasets/columns/update-column-name.mdx @@ -0,0 +1,67 @@ +--- +title: "Update Column Name" +description: "Rename an existing column in a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset that contains the column you want to rename. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + The universally unique identifier (UUID) of the column to rename. This ID is returned when a column is created and can be retrieved from the column details endpoint. + + + + + + The new human-readable name to assign to the column. This name is used to identify the column throughout the Future AGI platform, including in the dataset grid, evaluation configurations, and prompt template variable mappings. Must be unique within the dataset and cannot be empty. Any derived variable references in run prompt or prompt version configurations that use the old column name are automatically updated to reflect the new name. + + + + + + A human-readable confirmation message indicating that the column was successfully renamed. Any derived variable references in linked configurations are automatically updated. Typically returns `Column name updated successfully`. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `new_column_name` field is missing or empty; or a column with the same name already exists in the dataset. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified column or dataset was not found, or does not belong to your organization. Verify that both the `dataset_id` and `column_id` are correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/columns/update-column-type.mdx b/src/pages/docs/api/datasets/columns/update-column-type.mdx new file mode 100644 index 00000000..fa1a98eb --- /dev/null +++ b/src/pages/docs/api/datasets/columns/update-column-type.mdx @@ -0,0 +1,117 @@ +--- +title: "Update Column Type" +description: "Change the data type of an existing column with preview and conversion support." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset that contains the column whose type you want to change. This ID is returned when you create a dataset and can be found in the dataset listing or dataset detail endpoints. + + + The universally unique identifier (UUID) of the column to convert. This ID is returned when a column is created and can be retrieved from the column details endpoint. Only static columns (those without a source type) can have their data type changed. + + + + + + The target data type to convert the column to. This determines how existing cell values are interpreted and validated during conversion. Valid values: `text`, `number`, `boolean`, `json`, `image`, `audio`, `pdf`. + + + + Controls whether to preview the conversion or execute it. When set to `true` (the default), the API returns a compatibility analysis showing which values can and cannot be converted, without making any changes. Set to `false` to execute the actual conversion, which runs asynchronously as a background task. + + + + When set to `true`, forces the type conversion even if some cell values cannot be successfully converted to the target type. Inconvertible values may be set to null or a default value. Defaults to `false`, which requires all values to be convertible before proceeding. + + + + + The response structure varies depending on whether the request is in preview mode or execution mode. + + + A human-readable status message. Returns `success` for preview mode results, or `Column type conversion started` when the conversion is initiated in execution mode. + + + + Preview data containing conversion compatibility analysis. Only present in preview mode responses. + + + + The total number of cell values in the column that cannot be converted to the target data type. A count of zero indicates all values are compatible with the target type. + + + A sample list of cell values that cannot be converted to the target data type. Useful for identifying problematic data before executing the conversion. May be truncated for columns with many invalid values. + + + A mapping of sample original values to their converted equivalents, demonstrating how existing data will be transformed. Keys are the original string values and values are the converted representations in the target type. + + + The target data type that was evaluated in the preview. Matches the `new_column_type` value from the request. + + + + + The UUID of the column being converted. Only present in execution mode responses. + + + + The target data type the column is being converted to. Only present in execution mode responses. + + + + The current status of the conversion task. Returns `RUNNING` when the conversion has been initiated. Only present in execution mode responses. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the column has a source type (such as RUN_PROMPT or EVALUATION) and is not a static column; the provided `new_column_type` is not one of the supported data type values; or the conversion cannot proceed because too many values are incompatible and `force_update` is not enabled. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified column or dataset was not found, or does not belong to your organization. Verify that both the `dataset_id` and `column_id` are correct and that you have access to the dataset. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/create-dataset-from-huggingface.mdx b/src/pages/docs/api/datasets/create-dataset-from-huggingface.mdx new file mode 100644 index 00000000..a7d0ff08 --- /dev/null +++ b/src/pages/docs/api/datasets/create-dataset-from-huggingface.mdx @@ -0,0 +1,96 @@ +--- +title: "Create Dataset from HuggingFace" +description: "Create a new dataset by importing data from a HuggingFace dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The fully qualified path of the HuggingFace dataset to import. This can be a public dataset name such as `squad` or `glue`, or a user-scoped dataset in the format `username/dataset-name`. The dataset must be publicly accessible or accessible with the configured HuggingFace credentials. + + + + The specific configuration or subset of the HuggingFace dataset to import. Many HuggingFace datasets contain multiple configurations (e.g., `plain_text` for SQuAD, `mnli` for GLUE). If the dataset has only one configuration, this field can be omitted. + + + + The data split to import from the HuggingFace dataset. Common values include `train`, `test`, and `validation`. If not specified, the default split for the dataset is used. Only one split can be imported per request. + + + + The human-readable name to assign to the newly created dataset in Future AGI. If not provided, the name defaults to the HuggingFace dataset name with any `/` characters replaced by `_`. Must be unique within your organization. + + + + The model type classification for the dataset, which determines how the dataset is categorized and which evaluation templates are available. For example, `GenerativeLLM` indicates the dataset is intended for use with generative large language model evaluations. + + + + The maximum number of rows to import from the HuggingFace dataset split. Use this to limit the import size when working with large datasets. If not provided, all available rows from the specified split are imported. + + + + + + A human-readable confirmation message indicating that the dataset creation process has been initiated. Since data import from HuggingFace is processed asynchronously in the background, this message confirms the job was queued successfully. Typically returns `Dataset creation started successfully. Please check in some time`. + + + + The universally unique identifier (UUID) assigned to the newly created dataset. Use this ID to check the status of the import or reference the dataset in subsequent API calls once processing is complete. + + + + The name assigned to the created dataset, either matching the `name` value provided in the request body or the auto-generated name derived from the HuggingFace dataset path. + + + + The model type classification assigned to the dataset. This reflects the `model_type` value from the request, or the system default if none was specified. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the HuggingFace dataset could not be found or accessed; the specified configuration or split does not exist for the given dataset; a dataset with the same name already exists in your organization; or the `num_rows` value is not a valid non-negative integer. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + Resource limit reached. Your organization has exceeded the dataset creation or row addition quota. Contact support or upgrade your plan to increase limits. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/create-dataset.mdx b/src/pages/docs/api/datasets/create-dataset.mdx index 2a0629c1..3d2f0f51 100644 --- a/src/pages/docs/api/datasets/create-dataset.mdx +++ b/src/pages/docs/api/datasets/create-dataset.mdx @@ -3,24 +3,27 @@ title: "Create Dataset" description: "Create a new dataset with rows and columns in your organization." --- -# Create Dataset - -Create a new dataset with a specified number of rows and columns for evaluation, testing, or data management. - - +2 Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. @@ -28,128 +31,52 @@ Create a new dataset with a specified number of rows and columns for evaluation, -## Request Body - - - Name for the dataset. Must be unique within your organization. Maximum 2000 characters. - - - - Number of rows to create. Must be between 1 and 100. - - - - Number of columns to create. Must be between 1 and 100. Columns are created with default names (`Column 1`, `Column 2`, etc.) and `text` data type. - - -### Example - -```json -{ - "dataset_name": "My Evaluation Dataset", - "number_of_rows": 10, - "number_of_columns": 3 -} -``` - -## Response - -Returns the created dataset details. - -Confirmation message. Example: `Dataset created successfully`. -UUID of the newly created dataset. -Number of rows created in the dataset. -Number of columns created in the dataset. - -### Example Response - -```json -{ - "message": "Dataset created successfully", - "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", - "rows_created": 10, - "columns_created": 3 -} -``` - -## Responses - -### 200 - -Dataset created successfully. Returns the dataset ID, rows created, and columns created. - -### 400 - -Bad request. Possible reasons: - -- **Missing dataset name** - `dataset_name` is required. -- **Duplicate name** - A dataset with this name already exists in your organization. -- **Invalid row or column count** - `number_of_rows` and `number_of_columns` must be positive integers between 1 and 100. -- **Invalid number format** - The provided values are not valid integers. - -### 401 + + + The human-readable name to assign to the newly created dataset. This name is used to identify the dataset throughout the Future AGI platform, including in the dashboard, experiment configurations, and evaluation pipelines. Must be unique within your organization. Maximum 2000 characters. + -Authentication credentials were not provided or are invalid. + + The number of empty rows to initialize in the dataset upon creation. Each row represents a single data point that can later be populated with values for each column. Must be a positive integer between 1 and 100. + -### 429 + + The number of columns to create in the dataset schema. Each column is initialized with a sequentially generated default name (`Column 1`, `Column 2`, etc.) and a `text` data type. You can rename columns and change their types after creation. Must be a positive integer between 1 and 100. + + -Resource limit reached. Your organization has exceeded the dataset creation or row addition quota. + + + A human-readable confirmation message indicating that the dataset was created successfully. Typically returns `Dataset created successfully`. + -### 500 + + The universally unique identifier (UUID) assigned to the newly created dataset. Use this ID to reference the dataset in subsequent API calls such as updating, cloning, or deleting the dataset. + -Internal server error. Failed to create the dataset. + + The total number of rows that were successfully created in the dataset. This value matches the `number_of_rows` parameter from the request. + -## Code Examples + + The total number of columns that were successfully created in the dataset schema. This value matches the `number_of_columns` parameter from the request. + + - -```python Python -import requests + + + The request was malformed or contained invalid parameters. This can occur when: the `dataset_name` field is missing or empty; a dataset with the same name already exists in your organization; `number_of_rows` or `number_of_columns` is outside the allowed range of 1 to 100; or the provided values are not valid integers. + -url = "https://api.futureagi.com/model-hub/develops/create-dataset-manually/" -headers = { - "X-Api-Key": "YOUR_API_KEY", - "X-Secret-Key": "YOUR_SECRET_KEY", - "Content-Type": "application/json" -} -data = { - "dataset_name": "My Evaluation Dataset", - "number_of_rows": 10, - "number_of_columns": 3 -} + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + -response = requests.post(url, headers=headers, json=data) -print(response.json()) -``` -```typescript TypeScript -const response = await fetch( - "https://api.futureagi.com/model-hub/develops/create-dataset-manually/", - { - method: "POST", - headers: { - "X-Api-Key": "YOUR_API_KEY", - "X-Secret-Key": "YOUR_SECRET_KEY", - "Content-Type": "application/json" - }, - body: JSON.stringify({ - dataset_name: "My Evaluation Dataset", - number_of_rows: 10, - number_of_columns: 3 - }) - } -); + + Resource limit reached. Your organization has exceeded the dataset creation or row addition quota. Contact support or upgrade your plan to increase limits. + -const data = await response.json(); -console.log(data); -``` -```bash cURL -curl -X POST "https://api.futureagi.com/model-hub/develops/create-dataset-manually/" \ - -H "X-Api-Key: YOUR_API_KEY" \ - -H "X-Secret-Key: YOUR_SECRET_KEY" \ - -H "Content-Type: application/json" \ - -d '{ - "dataset_name": "My Evaluation Dataset", - "number_of_rows": 10, - "number_of_columns": 3 - }' -``` - + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/create-empty-dataset.mdx b/src/pages/docs/api/datasets/create-empty-dataset.mdx new file mode 100644 index 00000000..53695c50 --- /dev/null +++ b/src/pages/docs/api/datasets/create-empty-dataset.mdx @@ -0,0 +1,82 @@ +--- +title: "Create Empty Dataset" +description: "Create a new empty dataset with optional pre-created rows." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The human-readable name to assign to the newly created empty dataset. This name is used to identify the dataset throughout the Future AGI platform, including in the dashboard, experiment configurations, and evaluation pipelines. Must be unique within your organization. + + + + The model type classification for the dataset, which determines how the dataset is categorized and which evaluation templates are available. For example, `GenerativeLLM` indicates the dataset is intended for use with generative large language model evaluations. + + + + The number of empty rows to pre-create in the dataset upon initialization. This allows you to scaffold the dataset structure before populating data. Must be between 0 and 10. If omitted, no rows are created and the dataset starts completely empty. + + + + + + A human-readable confirmation message indicating that the empty dataset was created successfully. Typically returns `Empty dataset created successfully`. + + + + The universally unique identifier (UUID) assigned to the newly created dataset. Use this ID to reference the dataset in subsequent API calls such as adding rows, adding columns, or running evaluations. + + + + The name of the created dataset, matching the `new_dataset_name` value provided in the request body. + + + + The model type classification assigned to the dataset. This reflects the `model_type` value from the request, or the system default if none was specified. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `new_dataset_name` field is missing or empty; a dataset with the same name already exists in your organization; or the `row` value exceeds the maximum of 10. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + Resource limit reached. Your organization has exceeded the dataset creation quota. Contact support or upgrade your plan to increase limits. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/delete-dataset.mdx b/src/pages/docs/api/datasets/delete-dataset.mdx new file mode 100644 index 00000000..48951485 --- /dev/null +++ b/src/pages/docs/api/datasets/delete-dataset.mdx @@ -0,0 +1,62 @@ +--- +title: "Delete Dataset" +description: "Delete one or more datasets by their IDs." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + An array of universally unique identifiers (UUIDs) specifying the datasets to delete. This endpoint performs a soft delete, meaning the datasets are marked as deleted but may be recoverable within a retention window. Must contain at least 1 and at most 50 valid UUID strings. All specified datasets must belong to your organization. + + + + + + A human-readable confirmation message indicating how many datasets were successfully deleted. For example, `2 datasets deleted successfully`. + + + + The status of the API response. Returns `success` when all specified datasets were deleted without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `dataset_ids` array is empty; the array contains more than 50 entries; or one or more values are not valid UUID strings. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + One or more of the specified dataset IDs could not be found in your organization. Verify that all UUIDs are correct and that the datasets have not already been deleted. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/delete-rows.mdx b/src/pages/docs/api/datasets/delete-rows.mdx new file mode 100644 index 00000000..db77c0bf --- /dev/null +++ b/src/pages/docs/api/datasets/delete-rows.mdx @@ -0,0 +1,69 @@ +--- +title: "Delete Rows" +description: "Delete one or more rows from a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset from which rows will be deleted. The dataset must exist within your organization. + + + + + + An array of row UUIDs to delete from the dataset. Each entry must be a valid UUID string corresponding to an existing row in the specified dataset. This field is required when `selected_all_rows` is set to `false` or is omitted. The rows will be permanently removed and cannot be recovered. + + + A boolean flag that, when set to `true`, instructs the API to delete every row in the dataset, effectively clearing all data while preserving the dataset structure and columns. Defaults to `false`. When set to `true`, the `row_ids` field is ignored. + + + + + + A human-readable confirmation message indicating the rows were successfully deleted, such as `"Row deleted successfully"`. + + + Indicates the outcome of the API request. Returns `"success"` when the row deletion completes without errors. + + + + + + The request could not be processed. Possible reasons include: neither `row_ids` nor `selected_all_rows` was provided, or the provided row IDs do not match any existing rows in the dataset. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The specified dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + An unexpected error occurred on the server while deleting the rows. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/duplicate-dataset.mdx b/src/pages/docs/api/datasets/duplicate-dataset.mdx new file mode 100644 index 00000000..0dc278d4 --- /dev/null +++ b/src/pages/docs/api/datasets/duplicate-dataset.mdx @@ -0,0 +1,107 @@ +--- +title: "Duplicate Dataset" +description: "Create a new dataset from selected rows of an existing dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the source dataset to duplicate. The duplicate operation copies the dataset schema and selected rows into a new, independent dataset. + + + + + + The human-readable name to assign to the newly duplicated dataset. This name is used to identify the dataset throughout the Future AGI platform, including in the dashboard, experiment configurations, and evaluation pipelines. Must be unique within your organization. + + + + An array of row UUIDs specifying which individual rows from the source dataset to include in the duplicated dataset. Use this parameter for selective duplication when you only need a subset of the source data. If not provided and `selected_all_rows` is `false`, no rows are copied. + + + + A flag indicating whether to include all rows from the source dataset in the duplicate. When set to `true`, every row in the source dataset is copied regardless of the `row_ids` parameter. Defaults to `false` if not specified. + + + + + + The top-level data wrapper containing details about the newly created duplicate dataset. + + + + A human-readable confirmation message indicating that the dataset was duplicated successfully. Typically returns `Dataset duplicated successfully`. + + + The universally unique identifier (UUID) assigned to the newly duplicated dataset. Use this ID to reference the dataset in subsequent API calls. + + + The name assigned to the duplicated dataset, matching the `name` value provided in the request body. + + + The total number of columns that were copied from the source dataset into the new duplicate dataset. + + + The total number of rows that were copied from the source dataset into the new duplicate dataset. This reflects either the count of specified `row_ids` or the total row count if `selected_all_rows` was `true`. + + + + + The status of the API response. Returns `success` when the duplication was completed without errors. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `name` field is missing or empty; or a dataset with the same name already exists in your organization. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The source dataset could not be found. The provided ID does not match any dataset in your organization. Verify the dataset UUID is correct and that the dataset has not been deleted. + + + + Resource limit reached. Your organization has exceeded the dataset creation or row addition quota. Contact support or upgrade your plan to increase limits. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/duplicate-rows.mdx b/src/pages/docs/api/datasets/duplicate-rows.mdx new file mode 100644 index 00000000..53b4e7f9 --- /dev/null +++ b/src/pages/docs/api/datasets/duplicate-rows.mdx @@ -0,0 +1,98 @@ +--- +title: "Duplicate Rows" +description: "Create copies of specific rows within a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset containing the rows you want to duplicate. The dataset must exist within your organization. The newly created duplicate rows will be appended to the same dataset. + + + + + + An array of row UUIDs to duplicate within the dataset. Each entry must be a valid UUID string corresponding to an existing row. This field is required when `selected_all_rows` is set to `false` or is omitted. Each specified row will be copied the number of times defined by `num_copies`. + + + A boolean flag that, when set to `true`, instructs the API to duplicate every row in the dataset. Defaults to `false`. When set to `true`, the `row_ids` field is ignored and all rows are used as the source for duplication. + + + The number of copies to create for each source row. Must be a positive integer. Defaults to `1`. For example, if you specify 3 row IDs and set `num_copies` to 2, a total of 6 new rows will be created. + + + + + + The response payload containing details about the completed row duplication operation. + + + + A human-readable confirmation message indicating the rows were duplicated successfully, such as `"Rows duplicated successfully"`. + + + The number of original source rows that were used as the basis for duplication. + + + The number of copies that were created for each source row, corresponding to the `num_copies` value from the request. + + + The total number of new rows created during this operation, calculated as `source_rows` multiplied by `copies_per_row`. + + + An array of universally unique identifiers (UUIDs) for each newly created duplicate row. These IDs can be used to reference the new rows in subsequent API calls such as updating cell values or deleting rows. + + + + Indicates the outcome of the API request. Returns `"success"` when the row duplication completes without errors. + + + + + + The request could not be processed. Possible reasons include: neither `row_ids` nor `selected_all_rows` was provided, `num_copies` is not a positive integer, or the provided row IDs do not match any existing rows in the dataset. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The specified dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + Resource limit reached. Your organization has exceeded the row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while duplicating the rows. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/get-dataset.mdx b/src/pages/docs/api/datasets/get-dataset.mdx new file mode 100644 index 00000000..8db41f3b --- /dev/null +++ b/src/pages/docs/api/datasets/get-dataset.mdx @@ -0,0 +1,100 @@ +--- +title: "Get Dataset" +description: "Retrieve details of a specific dataset by ID." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset to retrieve. This ID is returned when a dataset is created and can also be found by listing all datasets in your organization. + + + + + + The universally unique identifier (UUID) of the dataset. + + + + The human-readable name of the dataset as it appears in the Future AGI dashboard and throughout the platform. + + + + An array of column definition objects describing the schema of the dataset. Each object represents a single column with its identifier, display name, and data type. + + + + The unique identifier for the column within the dataset. + + + The human-readable display name of the column, such as `input`, `expected_output`, or a custom name you assigned. + + + The data type of the column, indicating how values in this column are stored and validated. Common types include `text`, `number`, and `boolean`. + + + + + The total number of data rows currently stored in the dataset. + + + + The ISO 8601 formatted timestamp indicating when the dataset was originally created. + + + + The model type classification of the dataset, such as `GenerativeLLM`, indicating the intended use case for evaluations and experiments. + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset could not be found. The provided ID does not match any dataset in your organization. Verify the dataset UUID is correct and that the dataset has not been deleted. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/list-datasets.mdx b/src/pages/docs/api/datasets/list-datasets.mdx new file mode 100644 index 00000000..b3e4722c --- /dev/null +++ b/src/pages/docs/api/datasets/list-datasets.mdx @@ -0,0 +1,121 @@ +--- +title: "List Datasets" +description: "Retrieve a paginated list of datasets in your organization." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The zero-indexed page number to retrieve from the paginated result set. The first page is `0`, the second page is `1`, and so on. Defaults to `0` if not specified. + + + + The maximum number of dataset records to return per page. Must be a positive integer between 1 and 100. Defaults to `10` if not specified. Use larger values to reduce the number of paginated requests needed to retrieve all datasets. + + + + A case-insensitive text filter applied to dataset names. Only datasets whose names contain the specified substring are included in the results. Useful for quickly finding datasets by partial name match. + + + + A JSON-encoded array of sort objects that control the ordering of results. Each sort object must contain a `column_id` field (one of `name`, `numberOfDatapoints`, `numberOfExperiments`, `numberOfOptimisations`, `derivedDatasets`, `createdAt`) and a `type` field (`ascending` or `descending`). Multiple sort objects can be provided to define multi-level sorting. + + + + + + The top-level data wrapper containing the paginated dataset listing and metadata. + + + + An array of dataset summary objects representing the datasets that match the query criteria for the current page. + + + + The universally unique identifier (UUID) of the dataset. Use this ID to reference the dataset in other API calls. + + + The human-readable name of the dataset as it appears in the Future AGI dashboard and throughout the platform. + + + The total number of data rows currently stored in the dataset. + + + The number of experiments that have been linked to or run against this dataset. + + + The number of optimization runs that have been linked to or executed against this dataset. + + + The number of datasets that have been derived (cloned or duplicated) from this dataset. + + + The timestamp indicating when the dataset was created, formatted as `YYYY-MM-DD HH:MM`. + + + The model type classification of the dataset, such as `GenerativeLLM`, indicating the intended use case. + + + + The total number of pages available given the current `page_size` and the total number of matching datasets. + + + The total number of datasets in your organization that match the applied search and filter criteria. + + + + + The status of the API response. Returns `success` when the request was processed without errors. + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/merge-dataset.mdx b/src/pages/docs/api/datasets/merge-dataset.mdx new file mode 100644 index 00000000..07b5b26e --- /dev/null +++ b/src/pages/docs/api/datasets/merge-dataset.mdx @@ -0,0 +1,90 @@ +--- +title: "Merge Dataset" +description: "Merge rows from one dataset into another dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the source dataset whose rows you want to merge into another dataset. This dataset must exist within your organization and contain at least one row. + + + + + + The universally unique identifier (UUID) of the destination dataset that will receive the merged rows. Columns are matched by name and data type between the source and target datasets. Any source columns that do not have a matching column in the target dataset will be automatically created. This value cannot be the same as the source dataset ID. + + + An array of row UUIDs from the source dataset that you want to merge into the target. Each entry must be a valid UUID string corresponding to an existing row in the source dataset. If this field is omitted, the merge operation will include all rows from the source dataset. + + + A boolean flag that, when set to `true`, instructs the API to merge every row from the source dataset into the target dataset, regardless of whether `row_ids` is provided. Defaults to `false`. When `true`, the `row_ids` field is ignored. + + + + + + The response payload containing details about the completed merge operation. + + + + A human-readable confirmation message indicating the merge completed successfully, such as `"Dataset merged successfully"`. + + + The total number of rows that were successfully copied from the source dataset into the target dataset during this merge operation. + + + The number of new columns that were created in the target dataset to accommodate source columns that did not have a matching column by name and data type. + + + + Indicates the outcome of the API request. Returns `"success"` when the merge operation completes without errors. + + + + + + The request could not be processed. Possible reasons include: `target_dataset_id` is missing or invalid, the source and target datasets are the same, or the source dataset contains no rows to merge. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The source or target dataset could not be found. Confirm that both dataset UUIDs are valid and belong to your organization. + + + Resource limit reached. Your organization has exceeded the row addition quota. Contact support or wait before retrying. + + + An unexpected error occurred on the server while processing the merge operation. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/run-prompt/add-run-prompt-column.mdx b/src/pages/docs/api/datasets/run-prompt/add-run-prompt-column.mdx new file mode 100644 index 00000000..1e67f8d8 --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/add-run-prompt-column.mdx @@ -0,0 +1,126 @@ +--- +title: "Add Run Prompt Column" +description: "Add a new run prompt column to a dataset that generates LLM responses for each row." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset to which the new run prompt column will be added. The dataset must exist within your organization and be accessible with your current API credentials. + + + + The human-readable name to assign to the new column. This name is displayed in the dataset table and must be unique within the dataset. Minimum length is 1 character. + + + + The prompt configuration object that controls how the LLM generates responses for each row. This object specifies the model, prompt messages, sampling parameters, and output format. + + + + The identifier of the language model to use for generation (e.g., `gpt-4o`, `gpt-4o-mini`, `claude-3-5-sonnet`). This determines which LLM provider and model processes each row in the dataset. + + + + An ordered array of message objects defining the prompt sent to the LLM. Each message has a `role` (e.g., `system`, `user`, `assistant`) and `content` string. Use `{{column_name}}` syntax within content strings to reference values from other columns in the dataset, enabling dynamic per-row prompt generation. + + + + The format of the generated output. Accepted values are `string` (plain text, the default), `audio` (audio output from supported models), and `json` (structured JSON output). + + + + The sampling temperature controlling randomness in the model's output, ranging from `0` (deterministic) to `2` (highly creative). Default is `1`. Lower values produce more focused and consistent responses. + + + + The maximum number of tokens the model is allowed to generate in a single response. Setting this value helps control response length and associated costs. + + + + The nucleus sampling parameter, ranging from `0` to `1`. Only tokens with cumulative probability up to this value are considered during generation. Default is `1`. An alternative to temperature for controlling output diversity. + + + + A penalty applied to tokens based on how frequently they appear in the generated text so far, ranging from `-2` to `2`. Positive values discourage repetition. Default is `0`. + + + + A penalty applied to tokens based on whether they have appeared at all in the generated text so far, ranging from `-2` to `2`. Positive values encourage the model to introduce new topics. Default is `0`. + + + + An optional constraint on the response format returned by the model (e.g., `json_object`). When set, the model is instructed to produce output conforming to the specified format. + + + + The tool selection strategy that governs how the model decides whether to call a tool. Accepted values include `auto` (model decides), `none` (tools disabled), and `required` (model must call a tool). + + + + An array of tool definitions available to the model during generation. Each tool object includes an `id`, `name`, and `config` describing its capabilities. + + + + The number of concurrent requests to execute simultaneously. Controls how many dataset rows are processed in parallel, allowing you to balance throughput against rate limits. + + + + + + + + A human-readable confirmation message indicating that the run prompt column was successfully created and prompt execution has been queued. Rows are processed asynchronously in the background. Typically returns `Run prompt column added successfully`. + + + + + + The request was malformed or contained invalid parameters. This can occur when: `dataset_id` is missing; `name` is missing or shorter than 1 character; a column with the same name already exists in the dataset; or the prompt configuration is invalid. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify the `dataset_id` is correct and that your API credentials have access to the target dataset. + + + + An unexpected error occurred on the server while creating the run prompt column. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/run-prompt/edit-run-prompt-column.mdx b/src/pages/docs/api/datasets/run-prompt/edit-run-prompt-column.mdx new file mode 100644 index 00000000..8fd9faa2 --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/edit-run-prompt-column.mdx @@ -0,0 +1,78 @@ +--- +title: "Edit Run Prompt Column" +description: "Update the configuration of an existing run prompt column and re-execute the prompt." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset that contains the run prompt column to be edited. The dataset must exist within your organization and be accessible with your current API credentials. + + + + The universally unique identifier (UUID) of the run prompt column to update. The column must be of type `RUN_PROMPT` within the specified dataset. All existing cell values in this column will be cleared and regenerated with the new configuration. + + + + An optional new name for the column. If not provided, the existing column name is retained. The name must be unique within the dataset. + + + + The updated prompt configuration object. Accepts the same structure as the config in [Add Run Prompt Column](/docs/api/datasets/run-prompt/add-run-prompt-column), including `model`, `messages`, `temperature`, `max_tokens`, `top_p`, `frequency_penalty`, `presence_penalty`, `response_format`, `tool_choice`, `tools`, `output_format`, and `concurrency`. Only the fields you provide will be updated. + + + + + + A human-readable confirmation message indicating that the run prompt column configuration was successfully updated and re-execution has been queued. All existing cell values are cleared and regenerated asynchronously in the background. Typically returns `Run prompt column updated successfully`. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the specified column is not a `RUN_PROMPT` column; or the prompt configuration is invalid. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset or column was not found, or does not belong to your organization. Verify that both `dataset_id` and `column_id` are correct and that your API credentials have access to the target resources. + + + + An unexpected error occurred on the server while updating the run prompt column. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/run-prompt/get-column-values.mdx b/src/pages/docs/api/datasets/run-prompt/get-column-values.mdx new file mode 100644 index 00000000..ad90fba7 --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/get-column-values.mdx @@ -0,0 +1,111 @@ +--- +title: "Get Column Values" +description: "Retrieve sample values from specified columns in a dataset for prompt preview." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset from which to retrieve sample column values. The dataset must exist within your organization and be accessible with your current API credentials. + + + + A mapping of placeholder names to column UUIDs. The keys represent the placeholder variable names used in prompt templates (e.g., `input`, `context`), and the values are the UUIDs of the corresponding dataset columns. This allows you to preview what data will be injected into template variables before configuring a run prompt column. + + + + + + A status message indicating the outcome of the request. Returns `success` when column values are retrieved without errors. + + + + The response payload containing the retrieved column values organized by placeholder name. + + + + + An object keyed by placeholder name, where each entry contains the column metadata and sample values. Up to 10 rows of data are returned for each requested column. + + + + + The universally unique identifier (UUID) of the column from which the sample values were retrieved. + + + + The display name of the column in the dataset, as it appears in the table header. + + + + An array of sample values from the column, containing up to 10 entries from the first rows of the dataset. Useful for previewing what data will populate template variables at runtime. + + + + + + + + The request was malformed or contained invalid parameters. This can occur when: `dataset_id` is missing; `column_placeholders` is missing; or one or more column UUIDs do not exist in the specified dataset. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset was not found or does not belong to your organization. Verify the `dataset_id` is correct and that your API credentials have access to the target dataset. + + + + An unexpected error occurred on the server while retrieving column values. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/run-prompt/get-model-voices.mdx b/src/pages/docs/api/datasets/run-prompt/get-model-voices.mdx new file mode 100644 index 00000000..3140a7e1 --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/get-model-voices.mdx @@ -0,0 +1,114 @@ +--- +title: "Get Model Voices" +description: "Retrieve available voice options for a specific model's audio output." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The identifier of the language model whose audio voice options you want to retrieve (e.g., `gpt-4o-audio-preview`). The model must support audio output capabilities. This parameter determines which provider's voice catalog is returned. + + + + + + A status message indicating the outcome of the request. Returns `success` when voice options are retrieved without errors. + + + + The voice configuration payload for the specified model, including available voices, supported audio formats, and default settings. + + + + + The identifier of the model for which voice options were retrieved, matching the value provided in the `model` query parameter. + + + + The name of the model provider that serves this model (e.g., `openai`, `elevenlabs`). This determines which voice catalog and audio rendering engine is used. + + + + Indicates whether this model supports custom (user-created) voices in addition to the built-in system voices. When `true`, custom TTS voices created by your organization can be used with this model. + + + + An array of voice objects representing all voices available for use with this model. Each voice includes its unique identifier, display name, and whether it is a built-in system voice or a custom voice created by your organization. + + + + + The unique identifier of the voice, used when configuring audio output in a run prompt column. + + + + The human-readable display name of the voice, shown in the UI when selecting voice options. + + + + The category of the voice. `system` indicates a built-in voice provided by the model provider, while `custom` indicates a voice created by your organization. + + + + + An array of strings listing the audio file formats supported by this model (e.g., `mp3`, `wav`, `opus`, `flac`). These determine which output encoding options are available when generating audio responses. + + + + The identifier of the default voice used when no specific voice is selected in the prompt configuration. This voice is automatically applied if the `voice` parameter is omitted. + + + + The default audio file format used when no specific format is selected in the prompt configuration (e.g., `mp3`). This format is automatically applied if the `format` parameter is omitted. + + + + + + + The request was malformed or missing required parameters. The `model` query parameter is required and must reference a valid model that supports audio output. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + An unexpected error occurred on the server while retrieving voice options. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/run-prompt/retrieve-run-prompt-column-config.mdx b/src/pages/docs/api/datasets/run-prompt/retrieve-run-prompt-column-config.mdx new file mode 100644 index 00000000..b435a7db --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/retrieve-run-prompt-column-config.mdx @@ -0,0 +1,147 @@ +--- +title: "Retrieve Run Prompt Column Config" +description: "Get the full configuration of an existing run prompt column." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the run prompt column whose configuration you want to retrieve. The column must be of type `RUN_PROMPT` and must belong to a dataset accessible by your organization. + + + + + + A status message indicating the outcome of the request. Returns `success` when the column configuration is retrieved without errors. + + + + The response payload containing the full run prompt column configuration. Column UUID references in messages are resolved back to column names for readability. + + + + + The complete configuration object for the run prompt column, including all model settings, prompt messages, sampling parameters, and output options. + + + + + The universally unique identifier (UUID) of the dataset that contains this run prompt column. + + + + The display name of the run prompt column as it appears in the dataset table. + + + + The identifier of the language model used for generation (e.g., `gpt-4o`, `claude-3-5-sonnet`). + + + + The ordered array of message objects defining the prompt. Column UUID references within message content are resolved back to human-readable `{{column_name}}` template variable syntax. + + + + The sampling temperature controlling randomness in the model's output, ranging from `0` to `2`. + + + + The frequency penalty applied to tokens based on their occurrence count in the generated text, ranging from `-2` to `2`. + + + + The presence penalty applied to tokens based on whether they have appeared at all in the generated text, ranging from `-2` to `2`. + + + + The maximum number of tokens the model is allowed to generate in a single response. + + + + The nucleus sampling parameter controlling token selection probability mass, ranging from `0` to `1`. + + + + The response format constraint applied to the model output (e.g., `json_object`), or `null` if no format constraint is set. + + + + The tool selection strategy governing how the model decides whether to call a tool (e.g., `auto`, `none`, `required`), or `null` if no tools are configured. + + + + The array of tool definitions available to the model during generation. Each tool includes an `id`, `name`, and `config` describing its capabilities. Returns an empty array when no tools are configured. + + + + The output format of the generated content. One of `string` (plain text), `audio` (audio output), or `json` (structured JSON output). + + + + The number of concurrent requests configured for parallel row processing. + + + + Additional run prompt settings specific to the column configuration. This object contains provider-specific or advanced configuration options. + + + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified column was not found or is not a run prompt column. Verify the `column_id` is correct and that the column is of type `RUN_PROMPT`. + + + + An unexpected error occurred on the server while retrieving the column configuration. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/run-prompt/retrieve-run-prompt-options.mdx b/src/pages/docs/api/datasets/run-prompt/retrieve-run-prompt-options.mdx new file mode 100644 index 00000000..83086430 --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/retrieve-run-prompt-options.mdx @@ -0,0 +1,137 @@ +--- +title: "Retrieve Run Prompt Options" +description: "Get available models, tools, output formats, and tool choices for run prompt configuration." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + A status message indicating the outcome of the request. Returns `success` when the available options are retrieved without errors. + + + + The response payload containing all available configuration options for setting up a run prompt column, including models, tools, output formats, and tool selection strategies. + + + + + An array of available language model objects that can be used for run prompt generation. Each model entry indicates its name, supported providers, and current availability status. + + + + + The identifier of the language model (e.g., `gpt-4o`, `claude-3-5-sonnet`). Use this value in the `config.model` field when creating or editing a run prompt column. + + + + An array of provider names that offer this model (e.g., `["openai"]`, `["anthropic"]`). A model may be available from multiple providers. + + + + Indicates whether the model is currently available for use. Models may become temporarily unavailable due to provider outages or capacity constraints. + + + + + The tool configuration schema describing the structure and validation rules for tool definitions. This schema guides how tools should be configured when added to a run prompt column. + + + + An array of tool objects available to your organization for use in run prompt columns. These tools can be referenced in the `config.tools` array when creating or editing a run prompt column. + + + + + The universally unique identifier (UUID) of the tool. Use this value when referencing the tool in a run prompt column configuration. + + + + The human-readable name of the tool, describing its function (e.g., `web_search`). + + + + The configuration object for the tool, containing provider-specific settings and parameters. + + + + The type of tool configuration, indicating how the tool is invoked by the model (e.g., `function`). + + + + A human-readable description of what the tool does and when the model should use it. + + + + + An array of supported output format options, each containing a `value` (the programmatic identifier to use in configuration) and a `label` (the human-readable display name). Standard options include `string`, `audio`, and `json`. + + + + An array of supported tool choice strategy options, each containing a `value` (the programmatic identifier to use in configuration) and a `label` (the human-readable display name). Standard options include `auto`, `none`, and `required`. + + + + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + An unexpected error occurred on the server while retrieving run prompt options. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/run-prompt/tts-voices.mdx b/src/pages/docs/api/datasets/run-prompt/tts-voices.mdx new file mode 100644 index 00000000..47507a3a --- /dev/null +++ b/src/pages/docs/api/datasets/run-prompt/tts-voices.mdx @@ -0,0 +1,102 @@ +--- +title: "TTS Voices" +description: "Manage custom text-to-speech voices for your organization." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The human-readable display name for the TTS voice. This name is shown in the UI when selecting a voice for audio output in run prompt columns. It should clearly describe the voice characteristics (e.g., "Customer Support Voice", "Narrator - Deep Male"). + + + + The provider-specific voice identifier used to reference this voice in the TTS engine. This value must match a valid voice ID recognized by the specified provider (e.g., a custom voice ID from OpenAI or ElevenLabs). + + + + The TTS provider that hosts this voice (e.g., `openai`, `elevenlabs`). The provider determines which voice rendering engine is used when generating audio output. + + + + The TTS model to use for audio rendering with this voice (e.g., `tts-1`, `tts-1-hd`). Different models offer varying quality levels and latency characteristics. If not provided, the provider's default model is used. + + + + A human-readable description of the voice characteristics, tone, and intended use case. This description helps team members select the appropriate voice when configuring audio output columns. + + + + + + The universally unique identifier (UUID) assigned to the TTS voice. Use this ID to reference, update, or delete the voice in subsequent API calls. + + + + The display name of the TTS voice as provided during creation or last update. + + + + The provider-specific voice identifier used by the TTS engine to render audio output. + + + + The TTS provider that hosts and renders this voice (e.g., `openai`, `elevenlabs`). + + + + The TTS model configured for this voice (e.g., `tts-1`, `tts-1-hd`). + + + + The human-readable description of the voice characteristics, tone, and intended use case. + + + + The ISO 8601 timestamp indicating when the TTS voice was created in the system. + + + + + + The request was malformed or contained invalid parameters. This can occur when required fields (`name`, `voice_id`, `provider`) are missing or contain invalid data. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified TTS voice was not found or does not belong to your organization. This error applies to retrieve, update, and delete operations on individual voices. + + + + An unexpected error occurred on the server while processing the TTS voice request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/update-cell-value.mdx b/src/pages/docs/api/datasets/update-cell-value.mdx new file mode 100644 index 00000000..42037f02 --- /dev/null +++ b/src/pages/docs/api/datasets/update-cell-value.mdx @@ -0,0 +1,73 @@ +--- +title: "Update Cell Value" +description: "Update the value of a specific cell in a dataset." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset containing the cell you want to update. The dataset must exist within your organization. + + + + + + The universally unique identifier (UUID) of the row containing the cell to update. The row must exist within the specified dataset. + + + The universally unique identifier (UUID) of the column containing the cell to update. The column must exist within the specified dataset and must be an editable column (system-generated columns cannot be modified). + + + The new value to set for the specified cell. The accepted format depends on the column's data type: for text columns, provide any string value; for boolean columns, provide `"true"` or `"false"` as a string; for image, audio, or document columns, upload a file using `multipart/form-data` content type instead of JSON. When using JSON, send the request with `application/json` content type. + + + + + + A human-readable confirmation message indicating the cell value was successfully updated, such as `"Cell value updated successfully"`. + + + Indicates the outcome of the API request. Returns `"success"` when the cell update completes without errors. + + + + + + The request could not be processed. Possible reasons include: `row_id` or `column_id` is missing, the specified row/column combination does not exist in the dataset, the column is a non-editable system-generated column, the value for a boolean column is not `"true"` or `"false"`, or the value exceeds the maximum allowed character length. + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and correct. + + + The specified dataset could not be found. Confirm that the dataset UUID is valid and belongs to your organization. + + + An unexpected error occurred on the server while updating the cell value. If the issue persists, contact Future AGI support. + + diff --git a/src/pages/docs/api/datasets/update-dataset.mdx b/src/pages/docs/api/datasets/update-dataset.mdx new file mode 100644 index 00000000..2876fd0d --- /dev/null +++ b/src/pages/docs/api/datasets/update-dataset.mdx @@ -0,0 +1,71 @@ +--- +title: "Update Dataset" +description: "Update dataset properties such as name." +--- + + + + + + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. + + + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). + + + + + + The universally unique identifier (UUID) of the dataset to update. This ID is returned when a dataset is created and can also be found by listing all datasets in your organization. + + + + + + The new human-readable name to assign to the dataset. This name replaces the current dataset name throughout the Future AGI platform, including in the dashboard, experiment references, and evaluation pipelines. Must be unique within your organization. + + + + + + The universally unique identifier (UUID) of the updated dataset, confirming which dataset was modified. + + + + The new name of the dataset after the update, reflecting the value provided in the request body. + + + + + + The request was malformed or contained invalid parameters. This can occur when: the `name` field is missing or empty; or a dataset with the same name already exists in your organization. + + + + Authentication credentials were not provided or are invalid. Verify that both `X-Api-Key` and `X-Secret-Key` headers are present and contain valid keys. + + + + The specified dataset could not be found. The provided ID does not match any dataset in your organization. Verify the dataset UUID is correct and that the dataset has not been deleted. + + + + An unexpected error occurred on the server while processing the request. If this persists, contact Future AGI support with details of your request. + + diff --git a/src/pages/docs/api/datasets/upload-dataset.mdx b/src/pages/docs/api/datasets/upload-dataset.mdx index 7e600bdc..9d61e523 100644 --- a/src/pages/docs/api/datasets/upload-dataset.mdx +++ b/src/pages/docs/api/datasets/upload-dataset.mdx @@ -3,16 +3,11 @@ title: "Upload Dataset from File" description: "Create a new dataset by uploading a local file." --- -# Upload Dataset from File - -Create a new dataset by uploading a file from your local machine. The file is uploaded and processed in the background, automatically detecting columns and data types. - - + Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the [Dashboard](https://app.futureagi.com) under Settings. - + Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the [Dashboard](https://app.futureagi.com). diff --git a/src/pages/docs/api/evals-list/getevalslist.mdx b/src/pages/docs/api/evals-list/getevalslist.mdx index 563e72b8..19b43d81 100644 --- a/src/pages/docs/api/evals-list/getevalslist.mdx +++ b/src/pages/docs/api/evals-list/getevalslist.mdx @@ -3,54 +3,130 @@ title: "Get Evals List" description: "Retrieves a list of evaluations for a given dataset, with options for filtering and ordering." --- +# Get Evals List + +Retrieves a list of evaluations available for a given dataset, including built-in and user-created evals, with support for filtering by category, type, tags, and use cases. + - - - Include your API key in the `Authorization` header as `Bearer `. Retrieve your API Key from the [Dashboard](https://app.futureagi.com). - - - - - - The UUID of the dataset for which to retrieve the evaluations. - - - - - - Text to search for in the evaluation names. - - - - - - The list of evaluations matching the query. - - - A list of recommended evaluation categories. - - - - - - Invalid parameters provided, such as a non-existent experiment ID. - - - Authentication credentials were not provided or are invalid. - - - The requested dataset does not exist. - - - An unexpected error occurred while fetching the evaluations list. - - +## Authentication + +All requests require authentication via API keys: + +| Header | Description | +|--------|-------------| +| `X-Api-Key` | Your API key | +| `X-Secret-Key` | Your secret key | + +## Parameters + +### Path Parameters + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| `dataset_id` | string (UUID) | Yes | The UUID of the dataset to retrieve evaluations for. | + +### Query Parameters + +| Parameter | Type | Required | Description | +|-----------|------|----------|-------------| +| `search_text` | string | No | Text to search for in evaluation names (case-insensitive). | +| `eval_categories` | string | No | Filter by category. One of: `futureagi_built`, `user_built`. | +| `eval_type` | string | No | Filter by type. One of: `preset`, `user`, `previously_configured`. | +| `eval_tags[]` | array | No | Filter by one or more eval tags. | +| `use_cases[]` | array | No | Filter by one or more use cases. | +| `experiment_id` | string (UUID) | No | Scope results to a specific experiment. The experiment must exist and belong to the dataset. | +| `order` | string | No | Ordering mode. Use `simulate` for simulation-specific ordering. | + +## Responses + +### 200 + +A list of evaluations and recommendations. + +- **evals**: array of evaluation objects with id, name, description, and tags. +- **eval_recommendations**: array of string — recommended evaluation categories. + +### 400 + +Bad request. Possible reasons: + +- **Missing dataset ID** — `dataset_id` path parameter is required. +- **Experiment not found** — The specified `experiment_id` does not exist. + +### 401 + +Unauthorized. Authentication credentials were not provided or are invalid. + +### 404 + +Not Found. The requested dataset does not exist. + +### 500 + +Internal Server Error. An unexpected error occurred while fetching the evaluations list. + +## Code Examples + + +```python Python +import requests + +dataset_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890" +url = f"https://api.futureagi.com/model-hub/develops/{dataset_id}/get_evals_list/" +headers = { + "X-Api-Key": "YOUR_API_KEY", + "X-Secret-Key": "YOUR_SECRET_KEY", + "Content-Type": "application/json" +} +params = { + "search_text": "hallucination", + "eval_categories": "futureagi_built" +} + +response = requests.get(url, headers=headers, params=params) +print(response.json()) +``` +```typescript TypeScript +const datasetId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"; +const params = new URLSearchParams({ + search_text: "hallucination", + eval_categories: "futureagi_built" +}); + +const response = await fetch( + `https://api.futureagi.com/model-hub/develops/${datasetId}/get_evals_list/?${params}`, + { + method: "GET", + headers: { + "X-Api-Key": "YOUR_API_KEY", + "X-Secret-Key": "YOUR_SECRET_KEY", + "Content-Type": "application/json" + } + } +); + +const data = await response.json(); +console.log(data); +``` +```bash cURL +curl -X GET "https://api.futureagi.com/model-hub/develops/a1b2c3d4-e5f6-7890-abcd-ef1234567890/get_evals_list/?search_text=hallucination&eval_categories=futureagi_built" \ + -H "X-Api-Key: YOUR_API_KEY" \ + -H "X-Secret-Key: YOUR_SECRET_KEY" \ + -H "Content-Type: application/json" +``` +