Create
Create a Workspace
/v2/gen-ai/workspaces
To create a new workspace, send a POST request to /v2/gen-ai/workspaces. The response body contains a JSON object with the newly created workspace object.
Body Parameters
agent_uuids: optional array of string
Ids of the agents(s) to attach to the workspace
description: optional string
Description of the workspace
name: optional string
Name of the workspace
Returns
Create a Workspace
curl https://api.digitalocean.com/v2/gen-ai/workspaces \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
{
"workspace": {
"agents": [
{
"anthropic_api_key": {
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"api_key_infos": [
{
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"name": "example name",
"secret_key": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"api_keys": [
{
"api_key": "example string"
}
],
"chatbot": {
"allowed_domains": [
"example string"
],
"button_background_color": "example string",
"logo": "example string",
"name": "example name",
"primary_color": "example string",
"secondary_color": "example string",
"starting_message": "example string"
},
"chatbot_identifiers": [
{
"agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
}
],
"child_agents": [],
"conversation_logs_enabled": true,
"created_at": "2023-01-01T00:00:00Z",
"deployment": {
"created_at": "2023-01-01T00:00:00Z",
"name": "example name",
"status": "STATUS_UNKNOWN",
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"visibility": "VISIBILITY_UNKNOWN"
},
"description": "example string",
"functions": [
{
"api_key": "example string",
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"description": "example string",
"faas_name": "example name",
"faas_namespace": "example name",
"input_schema": {},
"name": "example name",
"output_schema": {},
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"guardrails": [
{
"agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2023-01-01T00:00:00Z",
"default_response": "example string",
"description": "example string",
"guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_attached": true,
"is_default": true,
"metadata": {},
"name": "example name",
"priority": 123,
"type": "GUARDRAIL_TYPE_UNKNOWN",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"if_case": "example string",
"instruction": "example string",
"k": 123,
"knowledge_bases": [
{
"added_to_agent_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"database_id": "123e4567-e89b-12d3-a456-426614174000",
"embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_public": true,
"last_indexing_job": {
"completed_datasources": 123,
"created_at": "2023-01-01T00:00:00Z",
"data_source_jobs": [
{
"completed_at": "2023-01-01T00:00:00Z",
"data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
"error_details": "example string",
"error_msg": "example string",
"failed_item_count": "12345",
"indexed_file_count": "12345",
"indexed_item_count": "12345",
"removed_item_count": "12345",
"skipped_item_count": "12345",
"started_at": "2023-01-01T00:00:00Z",
"status": "DATA_SOURCE_STATUS_UNKNOWN",
"total_bytes": "12345",
"total_bytes_indexed": "12345",
"total_file_count": "12345"
}
],
"data_source_uuids": [
"example string"
],
"finished_at": "2023-01-01T00:00:00Z",
"is_report_available": true,
"knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
"phase": "BATCH_JOB_PHASE_UNKNOWN",
"started_at": "2023-01-01T00:00:00Z",
"status": "INDEX_JOB_STATUS_UNKNOWN",
"tokens": 123,
"total_datasources": 123,
"total_items_failed": "12345",
"total_items_indexed": "12345",
"total_items_removed": "12345",
"total_items_skipped": "12345",
"total_tokens": "12345",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"name": "example name",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"region": "example string",
"tags": [
"example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"user_id": "user_id",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"logging_config": {
"galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
"galileo_project_name": "example name",
"insights_enabled": true,
"insights_enabled_at": "2023-01-01T00:00:00Z",
"log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
"log_stream_name": "example name"
},
"max_tokens": 123,
"model": {
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
},
"model_provider_key": {
"api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"models": [
{
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
}
],
"name": "example name",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z"
},
"name": "example name",
"openai_api_key": {
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"models": [
{
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
}
],
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"parent_agents": [],
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"provide_citations": true,
"region": "example string",
"retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
"route_created_at": "2023-01-01T00:00:00Z",
"route_created_by": "12345",
"route_name": "example name",
"route_uuid": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example string"
],
"temperature": 123,
"template": {
"created_at": "2023-01-01T00:00:00Z",
"description": "example string",
"guardrails": [
{
"priority": 123,
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"instruction": "example string",
"k": 123,
"knowledge_bases": [
{
"added_to_agent_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"database_id": "123e4567-e89b-12d3-a456-426614174000",
"embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_public": true,
"last_indexing_job": {
"completed_datasources": 123,
"created_at": "2023-01-01T00:00:00Z",
"data_source_jobs": [
{
"completed_at": "2023-01-01T00:00:00Z",
"data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
"error_details": "example string",
"error_msg": "example string",
"failed_item_count": "12345",
"indexed_file_count": "12345",
"indexed_item_count": "12345",
"removed_item_count": "12345",
"skipped_item_count": "12345",
"started_at": "2023-01-01T00:00:00Z",
"status": "DATA_SOURCE_STATUS_UNKNOWN",
"total_bytes": "12345",
"total_bytes_indexed": "12345",
"total_file_count": "12345"
}
],
"data_source_uuids": [
"example string"
],
"finished_at": "2023-01-01T00:00:00Z",
"is_report_available": true,
"knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
"phase": "BATCH_JOB_PHASE_UNKNOWN",
"started_at": "2023-01-01T00:00:00Z",
"status": "INDEX_JOB_STATUS_UNKNOWN",
"tokens": 123,
"total_datasources": 123,
"total_items_failed": "12345",
"total_items_indexed": "12345",
"total_items_removed": "12345",
"total_items_skipped": "12345",
"total_tokens": "12345",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"name": "example name",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"region": "example string",
"tags": [
"example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"user_id": "user_id",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
"max_tokens": 123,
"model": {
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
},
"name": "example name",
"short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
"summary": "example string",
"tags": [
"example string"
],
"temperature": 123,
"template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
"top_p": 123,
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"top_p": 123,
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"user_id": "12345",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version_hash": "example string",
"vpc_egress_ips": [
"example string"
],
"vpc_uuid": "\"12345678-1234-1234-1234-123456789012\""
}
],
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"created_by_email": "[email protected]",
"deleted_at": "2023-01-01T00:00:00Z",
"description": "example string",
"evaluation_test_cases": [
{
"archived_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"created_by_user_email": "[email protected]",
"created_by_user_id": "12345",
"dataset": {
"created_at": "2023-01-01T00:00:00Z",
"dataset_name": "example name",
"dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
"file_size": "12345",
"has_ground_truth": true,
"row_count": 123
},
"dataset_name": "example name",
"dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
"description": "example string",
"latest_version_number_of_runs": 123,
"metrics": [
{
"description": "example string",
"inverted": true,
"metric_name": "example name",
"metric_type": "METRIC_TYPE_UNSPECIFIED",
"metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
"metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
"range_max": 123,
"range_min": 123
}
],
"name": "example name",
"star_metric": {
"metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "example name",
"success_threshold": 123,
"success_threshold_pct": 123
},
"test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
"total_runs": 123,
"updated_at": "2023-01-01T00:00:00Z",
"updated_by_user_email": "[email protected]",
"updated_by_user_id": "12345",
"version": 123
}
],
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}Returns Examples
{
"workspace": {
"agents": [
{
"anthropic_api_key": {
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"api_key_infos": [
{
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"name": "example name",
"secret_key": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"api_keys": [
{
"api_key": "example string"
}
],
"chatbot": {
"allowed_domains": [
"example string"
],
"button_background_color": "example string",
"logo": "example string",
"name": "example name",
"primary_color": "example string",
"secondary_color": "example string",
"starting_message": "example string"
},
"chatbot_identifiers": [
{
"agent_chatbot_identifier": "123e4567-e89b-12d3-a456-426614174000"
}
],
"child_agents": [],
"conversation_logs_enabled": true,
"created_at": "2023-01-01T00:00:00Z",
"deployment": {
"created_at": "2023-01-01T00:00:00Z",
"name": "example name",
"status": "STATUS_UNKNOWN",
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"visibility": "VISIBILITY_UNKNOWN"
},
"description": "example string",
"functions": [
{
"api_key": "example string",
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"description": "example string",
"faas_name": "example name",
"faas_namespace": "example name",
"input_schema": {},
"name": "example name",
"output_schema": {},
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"guardrails": [
{
"agent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2023-01-01T00:00:00Z",
"default_response": "example string",
"description": "example string",
"guardrail_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_attached": true,
"is_default": true,
"metadata": {},
"name": "example name",
"priority": 123,
"type": "GUARDRAIL_TYPE_UNKNOWN",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"if_case": "example string",
"instruction": "example string",
"k": 123,
"knowledge_bases": [
{
"added_to_agent_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"database_id": "123e4567-e89b-12d3-a456-426614174000",
"embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_public": true,
"last_indexing_job": {
"completed_datasources": 123,
"created_at": "2023-01-01T00:00:00Z",
"data_source_jobs": [
{
"completed_at": "2023-01-01T00:00:00Z",
"data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
"error_details": "example string",
"error_msg": "example string",
"failed_item_count": "12345",
"indexed_file_count": "12345",
"indexed_item_count": "12345",
"removed_item_count": "12345",
"skipped_item_count": "12345",
"started_at": "2023-01-01T00:00:00Z",
"status": "DATA_SOURCE_STATUS_UNKNOWN",
"total_bytes": "12345",
"total_bytes_indexed": "12345",
"total_file_count": "12345"
}
],
"data_source_uuids": [
"example string"
],
"finished_at": "2023-01-01T00:00:00Z",
"is_report_available": true,
"knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
"phase": "BATCH_JOB_PHASE_UNKNOWN",
"started_at": "2023-01-01T00:00:00Z",
"status": "INDEX_JOB_STATUS_UNKNOWN",
"tokens": 123,
"total_datasources": 123,
"total_items_failed": "12345",
"total_items_indexed": "12345",
"total_items_removed": "12345",
"total_items_skipped": "12345",
"total_tokens": "12345",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"name": "example name",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"region": "example string",
"tags": [
"example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"user_id": "user_id",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"logging_config": {
"galileo_project_id": "123e4567-e89b-12d3-a456-426614174000",
"galileo_project_name": "example name",
"insights_enabled": true,
"insights_enabled_at": "2023-01-01T00:00:00Z",
"log_stream_id": "123e4567-e89b-12d3-a456-426614174000",
"log_stream_name": "example name"
},
"max_tokens": 123,
"model": {
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
},
"model_provider_key": {
"api_key_uuid": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"models": [
{
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
}
],
"name": "example name",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z"
},
"name": "example name",
"openai_api_key": {
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"deleted_at": "2023-01-01T00:00:00Z",
"models": [
{
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
}
],
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"parent_agents": [],
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"provide_citations": true,
"region": "example string",
"retrieval_method": "RETRIEVAL_METHOD_UNKNOWN",
"route_created_at": "2023-01-01T00:00:00Z",
"route_created_by": "12345",
"route_name": "example name",
"route_uuid": "123e4567-e89b-12d3-a456-426614174000",
"tags": [
"example string"
],
"temperature": 123,
"template": {
"created_at": "2023-01-01T00:00:00Z",
"description": "example string",
"guardrails": [
{
"priority": 123,
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"instruction": "example string",
"k": 123,
"knowledge_bases": [
{
"added_to_agent_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"database_id": "123e4567-e89b-12d3-a456-426614174000",
"embedding_model_uuid": "123e4567-e89b-12d3-a456-426614174000",
"is_public": true,
"last_indexing_job": {
"completed_datasources": 123,
"created_at": "2023-01-01T00:00:00Z",
"data_source_jobs": [
{
"completed_at": "2023-01-01T00:00:00Z",
"data_source_uuid": "123e4567-e89b-12d3-a456-426614174000",
"error_details": "example string",
"error_msg": "example string",
"failed_item_count": "12345",
"indexed_file_count": "12345",
"indexed_item_count": "12345",
"removed_item_count": "12345",
"skipped_item_count": "12345",
"started_at": "2023-01-01T00:00:00Z",
"status": "DATA_SOURCE_STATUS_UNKNOWN",
"total_bytes": "12345",
"total_bytes_indexed": "12345",
"total_file_count": "12345"
}
],
"data_source_uuids": [
"example string"
],
"finished_at": "2023-01-01T00:00:00Z",
"is_report_available": true,
"knowledge_base_uuid": "123e4567-e89b-12d3-a456-426614174000",
"phase": "BATCH_JOB_PHASE_UNKNOWN",
"started_at": "2023-01-01T00:00:00Z",
"status": "INDEX_JOB_STATUS_UNKNOWN",
"tokens": 123,
"total_datasources": 123,
"total_items_failed": "12345",
"total_items_indexed": "12345",
"total_items_removed": "12345",
"total_items_skipped": "12345",
"total_tokens": "12345",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"name": "example name",
"project_id": "123e4567-e89b-12d3-a456-426614174000",
"region": "example string",
"tags": [
"example string"
],
"updated_at": "2023-01-01T00:00:00Z",
"user_id": "user_id",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"long_description": "\"Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped.\"",
"max_tokens": 123,
"model": {
"agreement": {
"description": "example string",
"name": "example name",
"url": "example string",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"created_at": "2023-01-01T00:00:00Z",
"inference_name": "example name",
"inference_version": "example string",
"is_foundational": true,
"metadata": {},
"name": "example name",
"parent_uuid": "123e4567-e89b-12d3-a456-426614174000",
"provider": "MODEL_PROVIDER_DIGITALOCEAN",
"updated_at": "2023-01-01T00:00:00Z",
"upload_complete": true,
"url": "example string",
"usecases": [
"MODEL_USECASE_AGENT",
"MODEL_USECASE_GUARDRAIL"
],
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version": {
"major": 123,
"minor": 123,
"patch": 123
}
},
"name": "example name",
"short_description": "\"This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases.\"",
"summary": "example string",
"tags": [
"example string"
],
"temperature": 123,
"template_type": "AGENT_TEMPLATE_TYPE_STANDARD",
"top_p": 123,
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
},
"top_p": 123,
"updated_at": "2023-01-01T00:00:00Z",
"url": "example string",
"user_id": "12345",
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"version_hash": "example string",
"vpc_egress_ips": [
"example string"
],
"vpc_uuid": "\"12345678-1234-1234-1234-123456789012\""
}
],
"created_at": "2023-01-01T00:00:00Z",
"created_by": "12345",
"created_by_email": "[email protected]",
"deleted_at": "2023-01-01T00:00:00Z",
"description": "example string",
"evaluation_test_cases": [
{
"archived_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"created_by_user_email": "[email protected]",
"created_by_user_id": "12345",
"dataset": {
"created_at": "2023-01-01T00:00:00Z",
"dataset_name": "example name",
"dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
"file_size": "12345",
"has_ground_truth": true,
"row_count": 123
},
"dataset_name": "example name",
"dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
"description": "example string",
"latest_version_number_of_runs": 123,
"metrics": [
{
"description": "example string",
"inverted": true,
"metric_name": "example name",
"metric_type": "METRIC_TYPE_UNSPECIFIED",
"metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
"metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
"range_max": 123,
"range_min": 123
}
],
"name": "example name",
"star_metric": {
"metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
"name": "example name",
"success_threshold": 123,
"success_threshold_pct": 123
},
"test_case_uuid": "123e4567-e89b-12d3-a456-426614174000",
"total_runs": 123,
"updated_at": "2023-01-01T00:00:00Z",
"updated_by_user_email": "[email protected]",
"updated_by_user_id": "12345",
"version": 123
}
],
"name": "example name",
"updated_at": "2023-01-01T00:00:00Z",
"uuid": "123e4567-e89b-12d3-a456-426614174000"
}
}