# Scale AI ## Docs - [Capabilities Changelog](https://docs.gp.scale.com/docs/capabilities/changelog.md) - [API Reference](https://docs.gp.scale.com/docs/capabilities/document-understanding/api-reference.md): REST API reference for Document Understanding (Dex) — projects, files, parse, extract, and vector stores. - [Best Practices](https://docs.gp.scale.com/docs/capabilities/document-understanding/best-practices.md): Quick start, optimization tips, data retention, and common patterns for Dex document understanding. - [Chunking](https://docs.gp.scale.com/docs/capabilities/document-understanding/chunking.md): Choose chunking strategies for parsed documents, Dex rechunking or Reducto parse-time chunking. - [Dex SDK API Reference](https://docs.gp.scale.com/docs/capabilities/document-understanding/dex-sdk-api-reference.md) - [Extract](https://docs.gp.scale.com/docs/capabilities/document-understanding/extract.md): Extract structured data from parse results or vector stores using LLM-powered extraction. - [File Management](https://docs.gp.scale.com/docs/capabilities/document-understanding/file-management.md): Upload, list, and manage files in Dex projects with pagination and filtering. - [Getting Started with Dex](https://docs.gp.scale.com/docs/capabilities/document-understanding/getting-started-with-dex.md) - [Introduction to Dex](https://docs.gp.scale.com/docs/capabilities/document-understanding/introduction-to-dex.md) - [Parse](https://docs.gp.scale.com/docs/capabilities/document-understanding/parse.md): Parse documents with Reducto or Iris, monitor async jobs, and handle multi-language documents. - [Troubleshooting Dex](https://docs.gp.scale.com/docs/capabilities/document-understanding/troubleshooting.md) - [Vector Stores](https://docs.gp.scale.com/docs/capabilities/document-understanding/vector-stores.md): Create vector stores for semantic search and RAG-enhanced extraction from large or multi-file documents. - [Getting Started with IRIS](https://docs.gp.scale.com/docs/capabilities/ocr/getting-started-with-iris.md) - [Introduction to IRIS](https://docs.gp.scale.com/docs/capabilities/ocr/introduction-to-iris.md) - [When to choose Iris?](https://docs.gp.scale.com/docs/capabilities/ocr/when-to-choose-iris.md): A guide to help you decide when to use Iris versus Reducto within Dex for document processing. - [SGP Capabilities Overview](https://docs.gp.scale.com/docs/capabilities/overview.md) - [Custom Images](https://docs.gp.scale.com/docs/capabilities/training/custom-images.md): Push Docker images to the SGP registry and use them in training jobs. - [Getting Started with Train](https://docs.gp.scale.com/docs/capabilities/training/getting-started-with-train.md): Submit your first GPU training job on Vertex AI, SageMaker, or Azure ML. - [Introduction to Train](https://docs.gp.scale.com/docs/capabilities/training/introduction-to-train.md): Run GPU training jobs across GCP, AWS, and Azure through a unified API. - [Storage Mounts](https://docs.gp.scale.com/docs/capabilities/training/storage-mounts.md): Mount cloud storage into training containers using a unified interface across GCP, AWS, and Azure. - [Guide to document understanding in Workflows](https://docs.gp.scale.com/docs/capabilities/workflows/dex-parsing-in-workflows.md): Tutorial for utilizing unstructured data for your workflows - [Guide to automating evals on Workflows](https://docs.gp.scale.com/docs/capabilities/workflows/evals-in-workflows.md): Tutorial workflow for automated evals for your agent - [How to use Workflows](https://docs.gp.scale.com/docs/capabilities/workflows/introduction-to-workflows.md): Overview of Durable Agentic Workflow Orchestrator on SGP - [AWS Architecture Reference](https://docs.gp.scale.com/docs/infrastructure/aws/aws-architecture-reference.md): Overview of the SGP AWS architecture - [AWS SGP Deployment](https://docs.gp.scale.com/docs/infrastructure/aws/aws-sgp-deployment.md): End-to-end guide to deploying SGP in an AWS account. - [Azure Architecture Reference](https://docs.gp.scale.com/docs/infrastructure/azure/azure-architecture-reference.md): Overview of the SGP Azure architecture - [Azure SGP Deployment](https://docs.gp.scale.com/docs/infrastructure/azure/azure-sgp-deployment.md): End-to-end guide to deploying SGP in an Azure subscription. - [GCP Architecture Reference](https://docs.gp.scale.com/docs/infrastructure/gcp/gcp-architecture-reference.md): Overview of the SGP GCP architecture - [GCP SGP Deployment](https://docs.gp.scale.com/docs/infrastructure/gcp/gcp-sgp-deployment.md): End-to-end guide to deploying SGP in a GCP project. - [System Manager](https://docs.gp.scale.com/docs/infrastructure/system-manager.md): Overview of the SGP System Manager deployment orchestrator - [Creating an Agent](https://docs.gp.scale.com/docs/v5/agents/agent-service/lifecycle/creating-agent-service-agents.md): How to create and publish an agent in the SGP UI. - [Deploying an Agent](https://docs.gp.scale.com/docs/v5/agents/agent-service/lifecycle/deploying-agent-service-agents.md): How to deploy and interact with agents in the SGP UI. - [Monitoring an Agent](https://docs.gp.scale.com/docs/v5/agents/agent-service/lifecycle/monitoring-agent-service-agents.md): How to monitor and evaluate agents in the SGP UI. - [Introduction to Agent Service](https://docs.gp.scale.com/docs/v5/agents/agent-service/overview.md): An overview of SGP's Agent Building Framework - [Agentex CI/CD](https://docs.gp.scale.com/docs/v5/agents/agentex/agentex-monitoring.md): Understand how to set up CI/CD for Agentex Agents - [Introduction to Agentex](https://docs.gp.scale.com/docs/v5/agents/agentex/overview.md): Learn about Agentex agent types and how to build them - [Agentic Agent](https://docs.gp.scale.com/docs/v5/agents/agentex/types/agentic-agent.md): How to interact with agentic (async) Agentex agents using the Agentex SDK - [Sync Agent](https://docs.gp.scale.com/docs/v5/agents/agentex/types/sync-agent.md): How to interact with synchronous (sync) Agentex agents using the Agentex SDK - [Introduction to Agents](https://docs.gp.scale.com/docs/v5/agents/overview.md): Gain an understanding of different agent types in SGP - [Authentication](https://docs.gp.scale.com/docs/v5/authentication.md) - [Evaluation Group Dashboards](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/eval-group-dashboards.md): Compare metrics across multiple evaluations with evaluation group dashboards - [Getting Started with Dashboards](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/getting-started.md): Step-by-step tutorial for creating your first evaluation dashboard - [Introduction to Evaluation Dashboards](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/overview.md): Create custom dashboards to visualize and analyze evaluation metrics - [Query Language Reference](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/query-language.md): Deep dive into QueryAST for building powerful evaluation queries - [Bar Chart Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/bar.md): Visualize comparisons across categories using bar charts - [Donut Chart Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/donut.md): Visualize categorical distributions as a donut/pie chart - [Heading Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/heading.md): Organize dashboards with simple section headers - [Histogram Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/histogram.md): Visualize data distributions across numerical ranges - [Markdown Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/markdown.md): Add rich text documentation, instructions, and notes to dashboards - [Metric Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/metric.md): Display single aggregation values like averages, counts, and percentiles - [Widget Types Overview](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/overview.md): Overview of all available widget types for evaluation dashboards - [Scatter Plot Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/scatter.md): Visualize relationships between two numerical dimensions - [Table Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/table.md): Display multi-dimensional data in rows and columns with grouping and sorting - [Timeseries Widget](https://docs.gp.scale.com/docs/v5/evaluation-dashboards/widget-types/timeseries.md): Track metrics over time with line charts - [Quick Start - AgentOps SDK](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/getting-started.md): Getting started with the ScaleGP AgentOps SDK - [Auditing Evaluations](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/labeling-evaluations/auditing-evaluations.md): Guide for auditing contributor evaluations - [Contributor and Auditor Metrics](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/labeling-evaluations/contributor-auditor-metrics.md): Understanding metrics for contributors and auditors - [Labeling Evaluations](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/labeling-evaluations/labeling-evaluations.md): Guide for labeling contributor evaluations - [Managing Contributor Evaluations](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/labeling-evaluations/managing-contributor-evaluations.md): Guide for managing contributor evaluations - [Introduction to Next Gen Evals](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/overview.md): A simplified and extendable update to SGP's evaluation framework - [Agent Evaluation](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/tasks/agent-evaluation.md): Leverage specialized agents to produce evaluation results. - [Agentex Evaluation](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/tasks/agentex-evaluation.md): Generate outputs using external Agentex agents. - [Auto Evaluation](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/tasks/auto-evaluation.md): Leverage LLM-based tasks to produce evaluation results. - [Contributor Evaluation](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/tasks/contributor-evaluation.md): Defer evaluation tasks to human contributors. - [Custom Function Evaluation](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/tasks/custom-function.md): Define your own Python scoring functions and run them as evaluation tasks. - [Agent as a Judge](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/ui-evaluations/agent-evaluation.md): Leverage specialized agents to produce evaluation results. - [Agentex Agent Output](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/ui-evaluations/agentex-evaluation.md): Generate evaluation outputs using external Agentex agents - [LLM as a Judge](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/ui-evaluations/auto-evaluation.md): Leverage LLM-based tasks to produce evaluation results. - [Contributor Evaluation](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/ui-evaluations/contributor-evaluation.md): Defer evaluation tasks to human contributors. - [Voice Evaluations](https://docs.gp.scale.com/docs/v5/next-gen-evaluation/voice-evaluations.md): End-to-end guide for creating evaluations with audio files - [SGP Overview](https://docs.gp.scale.com/docs/v5/overview/index.md): Overview of SGP - [Built-in Tracing Providers](https://docs.gp.scale.com/docs/v5/tracing/integrations/agentex/built-in-providers.md): Auto-trace LLM calls and tool invocations using Agentex's built-in provider integrations for OpenAI Agents SDK, LiteLLM, and LangGraph. - [Multi-Agent Tracing](https://docs.gp.scale.com/docs/v5/tracing/integrations/agentex/multi-agent-tracing.md): Propagate trace context across orchestrator and sub-agents to build unified, cross-agent trace trees. - [Agentex Tracing Overview](https://docs.gp.scale.com/docs/v5/tracing/integrations/agentex/overview.md): Instrument Agentex agents with tracing to capture every turn, LLM call, and tool invocation as structured spans in the SGP Traces UI. - [Span Hierarchy & Best Practices](https://docs.gp.scale.com/docs/v5/tracing/integrations/agentex/span-hierarchy.md): Naming conventions, input/output patterns, and the ideal trace tree structure for Agentex agents. - [OpenAI Agents Integration](https://docs.gp.scale.com/docs/v5/tracing/integrations/openai-agents.md): Automatically trace openai-agents workflows with the SGP processor. - [OpenTelemetry Integration](https://docs.gp.scale.com/docs/v5/tracing/integrations/opentelemetry.md): Instrument your agents with standard OpenTelemetry integrations and send traces to SGP - [Introduction to Tracing](https://docs.gp.scale.com/docs/v5/tracing/overview.md): Gain deep visibility into your workflows with tracing. - [Configuration Options](https://docs.gp.scale.com/docs/v5/tracing/sdk/configuration-options.md): Configure the SGP Tracing SDK's behavior. - [Creating Traces and Spans](https://docs.gp.scale.com/docs/v5/tracing/sdk/creating-traces-spans.md): Instrument your Python code with the Tracing SDK. - [Flushing Tracing Data](https://docs.gp.scale.com/docs/v5/tracing/sdk/flushing-data.md): Understand how and when to manually send buffered tracing data to SGP. - [Helper Methods](https://docs.gp.scale.com/docs/v5/tracing/sdk/helper-methods.md): Access the currently active span and trace in your application's execution context. - [Initialization](https://docs.gp.scale.com/docs/v5/tracing/sdk/initialization.md): Set up and initialize the Scale GP Tracing SDK in your Python applications. - [Distributed Tracing](https://docs.gp.scale.com/docs/v5/tracing/sdk/multi-process.md): Implement tracing across multiple processes and workers in your Python app. - [Profiler](https://docs.gp.scale.com/docs/v5/tracing/tracing-ui/profiler.md): Analyze aggregated performance metrics and identify bottlenecks across your traces. - [Trace Detail View](https://docs.gp.scale.com/docs/v5/tracing/tracing-ui/trace-detail-view.md): Inspect individual traces with comprehensive span-level details and visualizations. - [Traces](https://docs.gp.scale.com/docs/v5/tracing/tracing-ui/traces-table.md): Monitor and analyze your application traces through the dedicated Traces page. - [Create Api Key](https://docs.gp.scale.com/reference/agentex/agent-apikeys/create-api-key.md) - [Delete API key by ID](https://docs.gp.scale.com/reference/agentex/agent-apikeys/delete-api-key-by-id.md): Delete API key by ID. - [Delete API key by name](https://docs.gp.scale.com/reference/agentex/agent-apikeys/delete-api-key-by-name.md): Delete API key by name. - [List API keys for an agent ID](https://docs.gp.scale.com/reference/agentex/agent-apikeys/list-api-keys-for-an-agent-id.md): List API keys for an agent ID. - [Return named API key for the agent ID](https://docs.gp.scale.com/reference/agentex/agent-apikeys/return-named-api-key-for-the-agent-id.md): Return named API key for the agent ID. - [Return the API key by ID](https://docs.gp.scale.com/reference/agentex/agent-apikeys/return-the-api-key-by-id.md): Return API key by ID. - [Get Agent Task Tracker](https://docs.gp.scale.com/reference/agentex/agent-task-tracker/get-agent-task-tracker.md): Get agent task tracker by tracker ID - [List Agent Task Trackers](https://docs.gp.scale.com/reference/agentex/agent-task-tracker/list-agent-task-trackers.md): List all agent task trackers, optionally filtered by query parameters. - [Update Agent Task Tracker](https://docs.gp.scale.com/reference/agentex/agent-task-tracker/update-agent-task-tracker.md): Update agent task tracker by tracker ID - [Delete Agent by ID](https://docs.gp.scale.com/reference/agentex/agents/delete-agent-by-id.md): Delete an agent by its unique ID. - [Delete Agent by Name](https://docs.gp.scale.com/reference/agentex/agents/delete-agent-by-name.md): Delete an agent by its unique name. - [Forward request to agent by ID](https://docs.gp.scale.com/reference/agentex/agents/forward-request-to-agent-by-id.md): Forward a request to an agent by its unique ID. - [Forward request to agent by ID](https://docs.gp.scale.com/reference/agentex/agents/forward-request-to-agent-by-id-1.md): Forward a request to an agent by its unique ID. - [Get Agent by ID](https://docs.gp.scale.com/reference/agentex/agents/get-agent-by-id.md): Get an agent by its unique ID. - [Get Agent by Name](https://docs.gp.scale.com/reference/agentex/agents/get-agent-by-name.md): Get an agent by its unique name. - [Handle Agent RPC by ID](https://docs.gp.scale.com/reference/agentex/agents/handle-agent-rpc-by-id.md): Handle JSON-RPC requests for an agent by its unique ID. - [Handle Agent RPC by Name](https://docs.gp.scale.com/reference/agentex/agents/handle-agent-rpc-by-name.md): Handle JSON-RPC requests for an agent by its unique name. - [List Agents](https://docs.gp.scale.com/reference/agentex/agents/list-agents.md): List all registered agents, optionally filtered by query parameters. - [Register Agent](https://docs.gp.scale.com/reference/agentex/agents/register-agent.md): Register a new agent or update an existing one. - [Delete Thread](https://docs.gp.scale.com/reference/agentex/checkpoints/delete-thread.md) - [Get Checkpoint Tuple](https://docs.gp.scale.com/reference/agentex/checkpoints/get-checkpoint-tuple.md) - [List Checkpoints](https://docs.gp.scale.com/reference/agentex/checkpoints/list-checkpoints.md) - [Put Checkpoint](https://docs.gp.scale.com/reference/agentex/checkpoints/put-checkpoint.md) - [Put Writes](https://docs.gp.scale.com/reference/agentex/checkpoints/put-writes.md) - [Get Deployment by ID](https://docs.gp.scale.com/reference/agentex/deployment-history/get-deployment-by-id.md): Get a deployment record by its unique ID. - [List Deployments for an agent](https://docs.gp.scale.com/reference/agentex/deployment-history/list-deployments-for-an-agent.md): List deployment history for an agent. - [Create Deployment](https://docs.gp.scale.com/reference/agentex/deployments/create-deployment.md): Create a new deployment record in PENDING status. - [Delete Deployment](https://docs.gp.scale.com/reference/agentex/deployments/delete-deployment.md): Delete a non-production deployment. - [Get Deployment](https://docs.gp.scale.com/reference/agentex/deployments/get-deployment.md): Get a specific deployment by ID. - [List Deployments](https://docs.gp.scale.com/reference/agentex/deployments/list-deployments.md): List deployments for an agent, newest first. - [Preview RPC](https://docs.gp.scale.com/reference/agentex/deployments/preview-rpc.md): Send an RPC request to a specific deployment (for preview testing). - [Promote Deployment](https://docs.gp.scale.com/reference/agentex/deployments/promote-deployment.md): Promote a deployment to production with atomic cutover. - [Get Event](https://docs.gp.scale.com/reference/agentex/events/get-event.md) - [List Events](https://docs.gp.scale.com/reference/agentex/events/list-events.md): List events for a specific task and agent. - [Batch Create Messages](https://docs.gp.scale.com/reference/agentex/messages/batch-create-messages.md) - [Batch Update Messages](https://docs.gp.scale.com/reference/agentex/messages/batch-update-messages.md) - [Create Message](https://docs.gp.scale.com/reference/agentex/messages/create-message.md) - [Get Message](https://docs.gp.scale.com/reference/agentex/messages/get-message.md) - [List Messages](https://docs.gp.scale.com/reference/agentex/messages/list-messages.md): List messages for a task with offset-based pagination. - [List Messages Paginated](https://docs.gp.scale.com/reference/agentex/messages/list-messages-paginated.md): List messages for a task with cursor-based pagination. - [Update Message](https://docs.gp.scale.com/reference/agentex/messages/update-message.md) - [Create Schedule](https://docs.gp.scale.com/reference/agentex/schedules/create-schedule.md): Create a new schedule for recurring workflow execution for an agent. - [Delete Schedule](https://docs.gp.scale.com/reference/agentex/schedules/delete-schedule.md): Delete a schedule permanently. - [Get Schedule](https://docs.gp.scale.com/reference/agentex/schedules/get-schedule.md): Get details of a schedule by its name. - [List Agent Schedules](https://docs.gp.scale.com/reference/agentex/schedules/list-agent-schedules.md): List all schedules for an agent. - [Pause Schedule](https://docs.gp.scale.com/reference/agentex/schedules/pause-schedule.md): Pause a schedule to stop it from executing. - [Trigger Schedule](https://docs.gp.scale.com/reference/agentex/schedules/trigger-schedule.md): Trigger a schedule to run immediately, regardless of its regular schedule. - [Unpause Schedule](https://docs.gp.scale.com/reference/agentex/schedules/unpause-schedule.md): Unpause/resume a schedule to allow it to execute again. - [Create Span](https://docs.gp.scale.com/reference/agentex/spans/create-span.md): Create a new span with the provided parameters - [Get Span](https://docs.gp.scale.com/reference/agentex/spans/get-span.md): Get a span by ID - [List Spans](https://docs.gp.scale.com/reference/agentex/spans/list-spans.md): List all spans for a given trace ID - [Partial Update Span](https://docs.gp.scale.com/reference/agentex/spans/partial-update-span.md): Update a span with the provided output data and mark it as complete - [Create Task State](https://docs.gp.scale.com/reference/agentex/states/create-task-state.md) - [Delete Task State](https://docs.gp.scale.com/reference/agentex/states/delete-task-state.md) - [Get State by State ID](https://docs.gp.scale.com/reference/agentex/states/get-state-by-state-id.md): Get a state by its unique state ID. - [List States](https://docs.gp.scale.com/reference/agentex/states/list-states.md): List all states, optionally filtered by query parameters. - [Update Task State](https://docs.gp.scale.com/reference/agentex/states/update-task-state.md) - [Cancel Task](https://docs.gp.scale.com/reference/agentex/tasks/cancel-task.md): Mark a running task as canceled. - [Complete Task](https://docs.gp.scale.com/reference/agentex/tasks/complete-task.md): Mark a running task as completed. - [Delete Task by ID](https://docs.gp.scale.com/reference/agentex/tasks/delete-task-by-id.md): Delete a task by its unique ID. - [Delete Task by Name](https://docs.gp.scale.com/reference/agentex/tasks/delete-task-by-name.md): Delete a task by its unique name. - [Fail Task](https://docs.gp.scale.com/reference/agentex/tasks/fail-task.md): Mark a running task as failed. - [Get Task by ID](https://docs.gp.scale.com/reference/agentex/tasks/get-task-by-id.md): Get a task by its unique ID. - [Get Task by Name](https://docs.gp.scale.com/reference/agentex/tasks/get-task-by-name.md): Get a task by its unique name. - [List Tasks](https://docs.gp.scale.com/reference/agentex/tasks/list-tasks.md): List all tasks. - [Query Task Workflow](https://docs.gp.scale.com/reference/agentex/tasks/query-task-workflow.md): Query a Temporal workflow associated with a task for its current state. - [Stream Task Events by ID](https://docs.gp.scale.com/reference/agentex/tasks/stream-task-events-by-id.md): Stream events for a task by its unique ID. - [Stream Task Events by Name](https://docs.gp.scale.com/reference/agentex/tasks/stream-task-events-by-name.md): Stream events for a task by its unique name. - [Terminate Task](https://docs.gp.scale.com/reference/agentex/tasks/terminate-task.md): Mark a running task as terminated. - [Timeout Task](https://docs.gp.scale.com/reference/agentex/tasks/timeout-task.md): Mark a running task as timed out. - [Update Task by ID](https://docs.gp.scale.com/reference/agentex/tasks/update-task-by-id.md): Update mutable fields for a task by its unique ID. - [Update Task by Name](https://docs.gp.scale.com/reference/agentex/tasks/update-task-by-name.md): Update mutable fields for a task by its unique Name. - [Create Extract Job](https://docs.gp.scale.com/reference/dex/extract/create-extract-job.md): Create a new extract job. - [Get Extraction](https://docs.gp.scale.com/reference/dex/extract/get-extraction.md): Get an extraction by ID (job ID) within the specified project. - [List Extractions](https://docs.gp.scale.com/reference/dex/extract/list-extractions.md): List all extractions for a project with token-based pagination and filtering. - [Delete File](https://docs.gp.scale.com/reference/dex/files/delete-file.md): Delete a file from both storage and the database. - [Get By Id](https://docs.gp.scale.com/reference/dex/files/get-by-id.md): Fetch a file by id - [Get File Download Url](https://docs.gp.scale.com/reference/dex/files/get-file-download-url.md): Get a secure, time-limited URL to download the content of a previously uploaded file. - [List Files](https://docs.gp.scale.com/reference/dex/files/list-files.md): List all files for a project with optional pagination and filtering. - [Stream File Content](https://docs.gp.scale.com/reference/dex/files/stream-file-content.md): Stream the raw byte content of a file directly. - [Upload File](https://docs.gp.scale.com/reference/dex/files/upload-file.md): Upload a file and store it in the configured storage backend. - [Cancel Job](https://docs.gp.scale.com/reference/dex/jobs/cancel-job.md): Cancel a running or pending job. - [Get Job](https://docs.gp.scale.com/reference/dex/jobs/get-job.md): Get a job by ID within the specified project. - [List Jobs](https://docs.gp.scale.com/reference/dex/jobs/list-jobs.md): List all jobs for a project with token-based pagination and filtering. - [Create Chunk Job](https://docs.gp.scale.com/reference/dex/parse/create-chunk-job.md): Rechunk a parse result with a different chunking strategy. - [Create Parse Job](https://docs.gp.scale.com/reference/dex/parse/create-parse-job.md): Create a parse job that will asynchronously process a document. - [Get Parse Result](https://docs.gp.scale.com/reference/dex/parse/get-parse-result.md): Get a parse result by ID within the specified project. - [List Parse Results](https://docs.gp.scale.com/reference/dex/parse/list-parse-results.md): List all parse results for a project with token-based pagination and filtering. - [Upload Parse Result](https://docs.gp.scale.com/reference/dex/parse/upload-parse-result.md): Ingest a pre-computed parse result directly without creating a job. - [Create Project](https://docs.gp.scale.com/reference/dex/projects/create-project.md): Create a new project. - [Get Project](https://docs.gp.scale.com/reference/dex/projects/get-project.md): Get a project by ID. - [List Projects](https://docs.gp.scale.com/reference/dex/projects/list-projects.md): List all projects with pagination and filtering support. - [Update Project](https://docs.gp.scale.com/reference/dex/projects/update-project.md): Update a project. - [Add files to vector store](https://docs.gp.scale.com/reference/dex/vector-stores/add-files-to-vector-store.md): Add parsed files to a vector store for indexing and search. This endpoint initiates an asynchronous process to add files to a vector store: 1. Creates a background job to track the operation 2. Starts a Temporal workflow to process the files 3. Files are parsed, chunked, and emb… - [Create a new vector store](https://docs.gp.scale.com/reference/dex/vector-stores/create-a-new-vector-store.md): Create a new vector store for a project. This endpoint creates a vector store using the specified engine and configuration. Currently supports SGP Knowledge Base engine, but we plan to support more engines in the future. **Authentication:** - For SGP Knowledge Base, SGP cre… - [Delete a vector store](https://docs.gp.scale.com/reference/dex/vector-stores/delete-a-vector-store.md): Permanently delete a vector store and all its associated data. This endpoint performs a complete deletion of the vector store: 1. Deletes the vector store from the third-party engine 2. Removes all associated files and data 3. Deletes the vector store record from the database… - [Get vector store details](https://docs.gp.scale.com/reference/dex/vector-stores/get-vector-store-details.md): Retrieve detailed information about a specific vector store. This endpoint returns the complete metadata for a vector store including: - Vector store ID and name - Associated project ID - Engine type and configuration - Creation timestamp **Returns:** - Complete… - [List files in vector store](https://docs.gp.scale.com/reference/dex/vector-stores/list-files-in-vector-store.md): Retrieve a paginated list of files that have been added to a vector store. This endpoint returns all files that are currently indexed in the specified vector store, including their metadata such as file name, size, MIME type, and creation timestamp. **Token-based Pagination:**… - [List vector stores](https://docs.gp.scale.com/reference/dex/vector-stores/list-vector-stores.md): Retrieve a paginated list of vector stores for a project. This endpoint returns all vector stores associated with the specified project, with optional filtering by name and engine type. **Filtering:** - `name`: Filter vector stores by exact name match - `engine`: Filter… - [Remove files from vector store](https://docs.gp.scale.com/reference/dex/vector-stores/remove-files-from-vector-store.md): Remove specific files from a vector store. This endpoint removes files and their associated embeddings from the vector store: 1. Removes files from the third-party vector store engine 2. Deletes file associations from the database 3. All embeddings and searchable content for the… - [Search in vector store](https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-store.md): Perform semantic search within a vector store. This endpoint performs vector-based semantic search to find the most relevant content based on the provided query. The search uses embeddings to find semantically similar content. **Search Parameters:** - `query`: The search qu… - [Search in vector store's file](https://docs.gp.scale.com/reference/dex/vector-stores/search-in-vector-stores-file.md): Perform semantic search within a vector store and filter down to a specific file. Provide the file_id to search within the file, don't confuse it with parse_result_id, because the two are connected. This endpoint performs vector-based semantic search to find the most relevant content… - [Cancel Build](https://docs.gp.scale.com/reference/v5/agentex-cloud-build/cancel-build.md): Cancel a pending or running build. - [Get Build](https://docs.gp.scale.com/reference/v5/agentex-cloud-build/get-build.md): Get a build by ID, including current status from the cloud provider. - [List Builds](https://docs.gp.scale.com/reference/v5/agentex-cloud-build/list-builds.md) - [List Undeployed Agents](https://docs.gp.scale.com/reference/v5/agentex-cloud-build/list-undeployed-agents.md): List agents that exist only as cloud builds with no healthy deployment. - [Stream Build Logs](https://docs.gp.scale.com/reference/v5/agentex-cloud-build/stream-build-logs.md): Stream build logs via Server-Sent Events (SSE). - [Submit Build](https://docs.gp.scale.com/reference/v5/agentex-cloud-build/submit-build.md): Submit a container image build. - [Create Deployment](https://docs.gp.scale.com/reference/v5/agentex-cloud-deploy/create-deployment.md): Create a new deployment. - [Get Deployment](https://docs.gp.scale.com/reference/v5/agentex-cloud-deploy/get-deployment.md): Get a deployment by its ID. - [Get Deployment Logs](https://docs.gp.scale.com/reference/v5/agentex-cloud-deploy/get-deployment-logs.md): Get structured log lines for a deployment with cursor-based pagination. - [List Deployments](https://docs.gp.scale.com/reference/v5/agentex-cloud-deploy/list-deployments.md): List all deployments with pagination and optional filters. - [Create Credential](https://docs.gp.scale.com/reference/v5/credentials/create-credential.md): Create a new credential for storing sensitive data like API keys, tokens, or other secrets. - [Delete Credential](https://docs.gp.scale.com/reference/v5/credentials/delete-credential.md): Permanently delete a credential and all its associated data. - [Get Credential by ID](https://docs.gp.scale.com/reference/v5/credentials/get-credential-by-id.md): Retrieve a specific credential by its unique identifier. - [Get Credential by Name](https://docs.gp.scale.com/reference/v5/credentials/get-credential-by-name.md): Retrieve a specific credential by its name. - [Get Credential Secret by ID](https://docs.gp.scale.com/reference/v5/credentials/get-credential-secret-by-id.md): Retrieve the plaintext payload of a credential by its ID. - [Get Credential Secret by Name](https://docs.gp.scale.com/reference/v5/credentials/get-credential-secret-by-name.md): Retrieve the plaintext payload of a credential by its name. - [List Credentials](https://docs.gp.scale.com/reference/v5/credentials/list-credentials.md): Retrieve a paginated list of all credentials for the current account with optional name filtering. - [Update Credential](https://docs.gp.scale.com/reference/v5/credentials/update-credential.md): Update an existing credential's properties including name, description, type, payload, and metadata. - [Batch Create Dataset Items](https://docs.gp.scale.com/reference/v5/dataset-items/batch-create-dataset-items.md) - [Delete Dataset Item](https://docs.gp.scale.com/reference/v5/dataset-items/delete-dataset-item.md) - [Get Dataset Item](https://docs.gp.scale.com/reference/v5/dataset-items/get-dataset-item.md) - [List Dataset Items](https://docs.gp.scale.com/reference/v5/dataset-items/list-dataset-items.md) - [Update Dataset Item](https://docs.gp.scale.com/reference/v5/dataset-items/update-dataset-item.md) - [Create Dataset](https://docs.gp.scale.com/reference/v5/datasets/create-dataset.md) - [Delete Dataset](https://docs.gp.scale.com/reference/v5/datasets/delete-dataset.md) - [Get Dataset](https://docs.gp.scale.com/reference/v5/datasets/get-dataset.md) - [List Datasets](https://docs.gp.scale.com/reference/v5/datasets/list-datasets.md) - [Update or Restore Dataset](https://docs.gp.scale.com/reference/v5/datasets/update-or-restore-dataset.md) - [Create Evaluation Chart](https://docs.gp.scale.com/reference/v5/evaluation-charts/create-evaluation-chart.md): Create a new evaluation chart for an evaluation or evaluation group - [Delete Evaluation Chart](https://docs.gp.scale.com/reference/v5/evaluation-charts/delete-evaluation-chart.md): Delete an evaluation chart and its columns - [Get Evaluation Chart](https://docs.gp.scale.com/reference/v5/evaluation-charts/get-evaluation-chart.md): Get a single evaluation chart by ID - [List Evaluation Charts](https://docs.gp.scale.com/reference/v5/evaluation-charts/list-evaluation-charts.md): List charts filtered by evaluation_id or evaluation_group_id - [Patch Evaluation Chart](https://docs.gp.scale.com/reference/v5/evaluation-charts/patch-evaluation-chart.md): Partially update chart metadata (title, type). Columns cannot be modified via PATCH. - [Replace Evaluation Chart](https://docs.gp.scale.com/reference/v5/evaluation-charts/replace-evaluation-chart.md): Replace chart metadata and/or columns. Columns are replaced if provided. - [Add Widget to Dashboard](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/add-widget-to-dashboard.md): Create a new widget, add it to the dashboard, and compute its results - [Create Evaluation Dashboard](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/create-evaluation-dashboard.md): Create a new evaluation dashboard for an evaluation or evaluation group - [Delete Evaluation Dashboard](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/delete-evaluation-dashboard.md): Soft delete an evaluation dashboard - [Get Evaluation Dashboard](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/get-evaluation-dashboard.md): Get a single evaluation dashboard by ID - [List Evaluation Dashboards](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/list-evaluation-dashboards.md): List dashboards filtered by evaluation_id, evaluation_group_id, tags, creators, or search - [Patch Evaluation Dashboard](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/patch-evaluation-dashboard.md): Partially update dashboard metadata (name, description, widget_order) - [Remove Widget from Dashboard](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/remove-widget-from-dashboard.md): Remove a widget from the dashboard (does not delete the widget) - [Update Dashboard Widget](https://docs.gp.scale.com/reference/v5/evaluation-dashboards/update-dashboard-widget.md): Update a widget and compute its results. If the widget is only used by this dashboard, it is updated in place. If shared across multiple dashboards, a copy is created. - [Archive Evaluation Group](https://docs.gp.scale.com/reference/v5/evaluation-groups/archive-evaluation-group.md): Soft-delete an evaluation group and cascade to members, row identifiers, and charts - [Create Evaluation Group](https://docs.gp.scale.com/reference/v5/evaluation-groups/create-evaluation-group.md): Create a new evaluation group - [Get Evaluation Group](https://docs.gp.scale.com/reference/v5/evaluation-groups/get-evaluation-group.md): Get a single evaluation group by ID - [Get Evaluation Group Schema](https://docs.gp.scale.com/reference/v5/evaluation-groups/get-evaluation-group-schema.md): Get per-evaluation schemas for all members of a group. Returns individual schema for each member evaluation, enabling the frontend to filter columns by selected eval subset. - [List Evaluation Groups](https://docs.gp.scale.com/reference/v5/evaluation-groups/list-evaluation-groups.md): List all evaluation groups for the current account - [Patch Evaluation Group](https://docs.gp.scale.com/reference/v5/evaluation-groups/patch-evaluation-group.md): Partial update of evaluation group attributes (name, description, tags, metadata). Members cannot be modified via PATCH. - [Update Evaluation Group](https://docs.gp.scale.com/reference/v5/evaluation-groups/update-evaluation-group.md): Full update of evaluation group. All fields are replaced with provided values. Omitted optional fields are cleared. - [Export Evaluation Items](https://docs.gp.scale.com/reference/v5/evaluation-items/export-evaluation-items.md) - [Get Evaluation Item](https://docs.gp.scale.com/reference/v5/evaluation-items/get-evaluation-item.md) - [List Evaluation Items](https://docs.gp.scale.com/reference/v5/evaluation-items/list-evaluation-items.md) - [Archive Evaluation](https://docs.gp.scale.com/reference/v5/evaluations/archive-evaluation.md) - [Create Evaluation](https://docs.gp.scale.com/reference/v5/evaluations/create-evaluation.md) - [Filter Evaluations](https://docs.gp.scale.com/reference/v5/evaluations/filter-evaluations.md): Filter evaluations using metadata and other criteria. Supports up to 10 filters with AND logic. - [Get Available Evaluation Statuses](https://docs.gp.scale.com/reference/v5/evaluations/get-available-evaluation-statuses.md): Get list of all possible evaluation status values. - [Get Available Metadata Keys](https://docs.gp.scale.com/reference/v5/evaluations/get-available-metadata-keys.md): Get list of all available metadata, status, and tags keys for filtering. - [Get Evaluation](https://docs.gp.scale.com/reference/v5/evaluations/get-evaluation.md) - [Get Evaluation Data Schema](https://docs.gp.scale.com/reference/v5/evaluations/get-evaluation-data-schema.md): Get schema information for evaluation item data, including field names, types, and occurrence counts. - [Get Evaluation Taxonomy](https://docs.gp.scale.com/reference/v5/evaluations/get-evaluation-taxonomy.md): Get taxonomy JSON for contributor evaluation question tasks. - [List Evaluations](https://docs.gp.scale.com/reference/v5/evaluations/list-evaluations.md) - [Update or Restore Evaluation](https://docs.gp.scale.com/reference/v5/evaluations/update-or-restore-evaluation.md) - [Delete File](https://docs.gp.scale.com/reference/v5/files/delete-file.md) - [Get File](https://docs.gp.scale.com/reference/v5/files/get-file.md) - [Get File Content](https://docs.gp.scale.com/reference/v5/files/get-file-content.md) - [Import files from existing blob storage in cloud (batch operation)](https://docs.gp.scale.com/reference/v5/files/import-files-from-existing-blob-storage-in-cloud-batch-operation.md) - [List Files](https://docs.gp.scale.com/reference/v5/files/list-files.md) - [Update File](https://docs.gp.scale.com/reference/v5/files/update-file.md) - [Upload File](https://docs.gp.scale.com/reference/v5/files/upload-file.md) - [Chat Completions](https://docs.gp.scale.com/reference/v5/inference/chat-completions.md) - [Completions](https://docs.gp.scale.com/reference/v5/inference/completions.md) - [Generic Inference](https://docs.gp.scale.com/reference/v5/inference/generic-inference.md) - [List Chat Completion Models](https://docs.gp.scale.com/reference/v5/inference/list-chat-completion-models.md) - [Responses](https://docs.gp.scale.com/reference/v5/inference/responses.md) - [Create Model](https://docs.gp.scale.com/reference/v5/models/create-model.md) - [Delete Model](https://docs.gp.scale.com/reference/v5/models/delete-model.md) - [Get Model](https://docs.gp.scale.com/reference/v5/models/get-model.md) - [List Models](https://docs.gp.scale.com/reference/v5/models/list-models.md) - [Update Model](https://docs.gp.scale.com/reference/v5/models/update-model.md) - [Archive Question](https://docs.gp.scale.com/reference/v5/questions/archive-question.md): Archive a question by setting archived_at in the db - [Create Question](https://docs.gp.scale.com/reference/v5/questions/create-question.md) - [Get Question](https://docs.gp.scale.com/reference/v5/questions/get-question.md) - [List Questions](https://docs.gp.scale.com/reference/v5/questions/list-questions.md) - [Restore Archived Question](https://docs.gp.scale.com/reference/v5/questions/restore-archived-question.md) - [Update Question](https://docs.gp.scale.com/reference/v5/questions/update-question.md) - [Add Criterion to Rubric](https://docs.gp.scale.com/reference/v5/rubrics/add-criterion-to-rubric.md) - [Archive Rubric](https://docs.gp.scale.com/reference/v5/rubrics/archive-rubric.md) - [Create Rubric](https://docs.gp.scale.com/reference/v5/rubrics/create-rubric.md) - [Get Rubric](https://docs.gp.scale.com/reference/v5/rubrics/get-rubric.md) - [List Criterion Versions](https://docs.gp.scale.com/reference/v5/rubrics/list-criterion-versions.md) - [List Rubrics](https://docs.gp.scale.com/reference/v5/rubrics/list-rubrics.md) - [Update Criterion](https://docs.gp.scale.com/reference/v5/rubrics/update-criterion.md) - [Update or Restore Rubric](https://docs.gp.scale.com/reference/v5/rubrics/update-or-restore-rubric.md) - [Create Secret](https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/create-secret.md): Create an account-level secret. - [Delete Secret](https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/delete-secret.md): Delete a secret from both the cloud provider and SGP metadata. - [Get Secret](https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/get-secret.md): Get a single secret's metadata by ID. The value is never returned. - [List Secrets](https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/list-secrets.md): List secret metadata for the account. Values are never returned. - [Update Secret](https://docs.gp.scale.com/reference/v5/sgp-cloud-secrets/update-secret.md): Update an existing secret's description and/or value. - [Create Span Assessment](https://docs.gp.scale.com/reference/v5/span-assessment/create-span-assessment.md): Create new assessment for a span (comment, rating, approval, rubric, overwrite, or metadata) - [Delete Span Assessment](https://docs.gp.scale.com/reference/v5/span-assessment/delete-span-assessment.md): Delete assessment - [Get Span Assessment](https://docs.gp.scale.com/reference/v5/span-assessment/get-span-assessment.md): Get an assessment by ID - [List Span Assessments](https://docs.gp.scale.com/reference/v5/span-assessment/list-span-assessments.md): Get all assessments for a specific span or trace, optionally filtered by assessment type - [Update Span Assessment](https://docs.gp.scale.com/reference/v5/span-assessment/update-span-assessment.md): Update existing assessment (only by the original creator) - [Create Span](https://docs.gp.scale.com/reference/v5/spans/create-span.md) - [Create Spans in Batch](https://docs.gp.scale.com/reference/v5/spans/create-spans-in-batch.md) - [Export spans](https://docs.gp.scale.com/reference/v5/spans/export-spans.md) - [Get aggregated metrics grouped by span name](https://docs.gp.scale.com/reference/v5/spans/get-aggregated-metrics-grouped-by-span-name.md) - [Get bucketed metrics for spans](https://docs.gp.scale.com/reference/v5/spans/get-bucketed-metrics-for-spans.md) - [Get Span](https://docs.gp.scale.com/reference/v5/spans/get-span.md) - [Search and list spans](https://docs.gp.scale.com/reference/v5/spans/search-and-list-spans.md) - [Update Span](https://docs.gp.scale.com/reference/v5/spans/update-span.md) - [Upsert Spans in Batch](https://docs.gp.scale.com/reference/v5/spans/upsert-spans-in-batch.md) - [Configure Vector Store](https://docs.gp.scale.com/reference/v5/vector-stores/configure-vector-store.md): Update the indexed metadata fields configuration for a vector store. - [Count Vectors](https://docs.gp.scale.com/reference/v5/vector-stores/count-vectors.md): Count documents in a vector store, optionally filtered by metadata. - [Create Vector Store](https://docs.gp.scale.com/reference/v5/vector-stores/create-vector-store.md): Create a new vector store for storing and querying document embeddings. - [Delete Vectors](https://docs.gp.scale.com/reference/v5/vector-stores/delete-vectors.md): Delete documents from a vector store by document IDs or metadata filter criteria. - [Drop Vector Store](https://docs.gp.scale.com/reference/v5/vector-stores/drop-vector-store.md): Permanently delete a vector store and all its contents. - [Get Vector](https://docs.gp.scale.com/reference/v5/vector-stores/get-vector.md): Retrieve a single document by its unique ID. - [Get Vector Store](https://docs.gp.scale.com/reference/v5/vector-stores/get-vector-store.md): Retrieve detailed configuration and metadata for a specific vector store. - [List Vector Stores](https://docs.gp.scale.com/reference/v5/vector-stores/list-vector-stores.md): List all vector stores in your account with pagination. - [List Vectors](https://docs.gp.scale.com/reference/v5/vector-stores/list-vectors.md): List documents in a vector store with cursor-based pagination. - [Query Vectors](https://docs.gp.scale.com/reference/v5/vector-stores/query-vectors.md): Query documents using similarity search with optional reranking. - [Upsert Vectors](https://docs.gp.scale.com/reference/v5/vector-stores/upsert-vectors.md): Insert new documents or update existing documents in a vector store. ## OpenAPI Specs - [openapi](https://agentex.dev-sgp.scale.com/openapi.json) ## Optional - [AgentOps SDK](https://sgp-dev.stldocs.app/api/python) - [Agentex SDK](https://agentex-sdk.stldocs.app/api/python)