diff --git a/specification/DigitalOcean-public.v2.yaml b/specification/DigitalOcean-public.v2.yaml index 9bdbd9d1..82d26a4b 100644 --- a/specification/DigitalOcean-public.v2.yaml +++ b/specification/DigitalOcean-public.v2.yaml @@ -2189,6 +2189,67 @@ paths: delete: $ref: "resources/uptime/delete_alert.yml" + + /v2/gen-ai/agent-workspace-deployment-releases/{uuid}: + get: + $ref: 'resources/gen-ai/genai_get_agent_workspace_deployment_release.yml' + + + /v2/gen-ai/agent-workspace-deployments/file_upload_presigned_url: + post: + $ref: 'resources/gen-ai/genai_create_agent_deployment_file_upload_presigned_urls.yml' + + + /v2/gen-ai/agent-workspace-deployments/{agent_deployment_uuid}/releases: + get: + $ref: 'resources/gen-ai/genai_list_agent_workspace_deployment_releases.yml' + + + /v2/gen-ai/agent-workspaces: + get: + $ref: 'resources/gen-ai/genai_list_agent_workspaces.yml' + + post: + $ref: 'resources/gen-ai/genai_create_agent_workspace.yml' + + + /v2/gen-ai/agent-workspaces/{agent_workspace_name}: + get: + $ref: 'resources/gen-ai/genai_get_agent_workspace.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_agent_workspace.yml' + + + /v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments: + get: + $ref: 'resources/gen-ai/genai_list_agent_workspace_deployments.yml' + + post: + $ref: 'resources/gen-ai/genai_create_agent_workspace_deployment.yml' + + + /v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}: + get: + $ref: 'resources/gen-ai/genai_get_agent_workspace_deployment.yml' + + put: + $ref: 'resources/gen-ai/genai_update_agent_workspace_deployment.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_agent_workspace_deployment.yml' + + + /v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}/logs: + get: + $ref: 'resources/gen-ai/genai_get_agent_workspace_deployment_runtime_logs.yml' + + + /v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}/releases: + post: + $ref: 'resources/gen-ai/genai_create_agent_workspace_deployment_release.yml' + + /v2/gen-ai/agents: get: $ref: 'resources/gen-ai/genai_list_agents.yml' @@ -2419,6 +2480,9 @@ paths: /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}: + put: + $ref: 'resources/gen-ai/genai_update_knowledge_base_data_source.yml' + delete: $ref: 'resources/gen-ai/genai_delete_knowledge_base_data_source.yml' @@ -2464,11 +2528,22 @@ paths: put: $ref: 'resources/gen-ai/genai_regenerate_model_api_key.yml' + + /v2/gen-ai/models/api_keys/{uuid}/usage: + get: + $ref: 'resources/gen-ai/genai_get_serverless_inference_usage.yml' + + /v2/gen-ai/oauth2/dropbox/tokens: post: $ref: 'resources/gen-ai/genai_create_oauth2_dropbox_tokens.yml' + /v2/gen-ai/oauth2/google/tokens: + post: + $ref: 'resources/gen-ai/genai_create_oauth2_google_tokens.yml' + + /v2/gen-ai/oauth2/url: get: $ref: 'resources/gen-ai/genai_get_oauth2_url.yml' @@ -2518,6 +2593,15 @@ paths: $ref: 'resources/gen-ai/genai_delete_scheduled_indexing.yml' + /v2/gen-ai/traces: + post: + $ref: 'resources/gen-ai/genai_create_traces.yml' + + + /v2/gen-ai/tracing_tokens/{agent_workspace_uuid}/{agent_deployment_name}: + get: + $ref: 'resources/gen-ai/genai_get_tracing_service_jwt_token.yml' + /v2/gen-ai/workspaces: get: diff --git a/specification/resources/gen-ai/definitions.yml b/specification/resources/gen-ai/definitions.yml index 9b6e6c1b..a9f1475a 100644 --- a/specification/resources/gen-ai/definitions.yml +++ b/specification/resources/gen-ai/definitions.yml @@ -284,26 +284,6 @@ apiAgentChildRelationshipVerion: example: example name type: string type: object -apiAgentConversationLogConfig: - description: Response for getting or creating an agent conversation log location - properties: - agent_uuid: - description: Agent UUID - example: 123e4567-e89b-12d3-a456-426614174000 - type: string - created_at: - description: Creation date / time - example: "2023-01-01T00:00:00Z" - format: date-time - type: string - spaces_data_source: - $ref: '#/apiSpacesDataSource' - updated_at: - description: Last modified - example: "2023-01-01T00:00:00Z" - format: date-time - type: string - type: object apiAgentDeploymentCodeArtifact: description: File to upload properties: @@ -343,6 +323,10 @@ apiAgentDeploymentRelease: an error example: example string type: string + library_version: + description: The library version of the gradient package used in the release + example: example string + type: string status: $ref: '#/apiReleaseStatus' updated_at: @@ -729,6 +713,19 @@ apiAgentPublic: example: example string type: string type: object +apiAgentSpan: + properties: + agent_type: + $ref: '#/apiAgentType' + common: + $ref: '#/apiSpanCommon' + redacted_input: + example: example string + type: string + redacted_output: + example: example string + type: string + type: object apiAgentTemplate: description: Represents an AgentTemplate entity properties: @@ -843,6 +840,21 @@ apiAgentTemplateType: - AGENT_TEMPLATE_TYPE_ONE_CLICK example: AGENT_TEMPLATE_TYPE_STANDARD type: string +apiAgentType: + default: AGENT_TYPE_UNSPECIFIED + description: Agent span + enum: + - AGENT_TYPE_UNSPECIFIED + - AGENT_TYPE_DEFAULT + - AGENT_TYPE_PLANNER + - AGENT_TYPE_REACT + - AGENT_TYPE_REFLECTION + - AGENT_TYPE_ROUTER + - AGENT_TYPE_CLASSIFIER + - AGENT_TYPE_SUPERVISOR + - AGENT_TYPE_JUDGE + example: AGENT_TYPE_UNSPECIFIED + type: string apiAgentVersion: description: Represents an AgentVersion entity properties: @@ -1015,6 +1027,10 @@ apiAgentWorkspaceDeployment: example: "12345" format: uint64 type: string + description: + description: Description of the agent deployment + example: example string + type: string latest_release: $ref: '#/apiAgentDeploymentRelease' logging_config: @@ -1023,6 +1039,8 @@ apiAgentWorkspaceDeployment: description: Agent name example: example name type: string + region: + $ref: '#/apiAgentWorkspaceDeploymentRegion' updated_at: description: Last modified example: "2023-01-01T00:00:00Z" @@ -1033,6 +1051,22 @@ apiAgentWorkspaceDeployment: example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object +apiAgentWorkspaceDeploymentRegion: + default: AGENT_WORKSPACE_DEPLOYMENT_REGION_UNKNOWN + description: Regions where an Agent Workspace Deployment can be created + enum: + - AGENT_WORKSPACE_DEPLOYMENT_REGION_UNKNOWN + - AGENT_WORKSPACE_DEPLOYMENT_REGION_NYC3 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_AMS3 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_SFO3 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_SGP1 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_LON1 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_FRA1 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_TOR1 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_BLR1 + - AGENT_WORKSPACE_DEPLOYMENT_REGION_SYD1 + example: AGENT_WORKSPACE_DEPLOYMENT_REGION_UNKNOWN + type: string apiAgreement: description: Agreement Description properties: @@ -1183,32 +1217,23 @@ apiChatbot: type: string type: object apiChunkingAlgorithm: - default: CHUNKING_ALGORITHM_SECTION_BASED - description: |- - The chunking algorithm to use for processing data sources. - - **Note: This feature requires enabling the knowledgebase enhancements feature preview flag.** + default: CHUNKING_ALGORITHM_UNKNOWN enum: - CHUNKING_ALGORITHM_UNKNOWN - CHUNKING_ALGORITHM_SECTION_BASED - CHUNKING_ALGORITHM_HIERARCHICAL - CHUNKING_ALGORITHM_SEMANTIC - CHUNKING_ALGORITHM_FIXED_LENGTH - example: CHUNKING_ALGORITHM_SECTION_BASED + example: CHUNKING_ALGORITHM_UNKNOWN type: string apiChunkingOptions: - description: |- - Configuration options for the chunking algorithm. - - **Note: This feature requires enabling the knowledgebase enhancements feature preview flag.** properties: - child_chunk_size: - description: Hierarchical options + child_chunk_size: example: 350 format: int64 type: integer max_chunk_size: - description: Section_Based and Fixed_Length options + description: Common options example: 750 format: int64 type: integer @@ -1287,6 +1312,10 @@ apiCreateAgentDeploymentReleaseInputPublic: description: The name of agent workspace example: example name type: string + library_version: + description: The library version of the gradient package used in the release + example: example string + type: string type: object apiCreateAgentDeploymentReleaseOutput: description: One Agent Deployment Release @@ -1398,6 +1427,14 @@ apiCreateAgentWorkspaceDeploymentInputPublic: description: The name of agent workspace example: example name type: string + description: + description: The description of the agent deployment + example: example string + type: string + library_version: + description: The library version of the gradient package used in the release + example: example string + type: string type: object apiCreateAgentWorkspaceDeploymentOutput: description: One Agent Workspace Deployment @@ -1417,6 +1454,14 @@ apiCreateAgentWorkspaceInputPublic: description: The name of agent workspace example: example name type: string + description: + description: The description of the agent deployment + example: example string + type: string + library_version: + description: The library version of the gradient package used in the release + example: example string + type: string project_id: description: The project id example: 123e4567-e89b-12d3-a456-426614174000 @@ -1786,14 +1831,6 @@ apiDeleteAgentAPIKeyOutput: api_key_info: $ref: '#/apiAgentAPIKeyInfo' type: object -apiDeleteAgentConversationLogConfigOutput: - description: Output for deleting agent conversation log config - properties: - agent_uuid: - description: Agent UUID - example: 123e4567-e89b-12d3-a456-426614174000 - type: string - type: object apiDeleteAgentInputPublic: properties: uuid: @@ -3355,6 +3392,40 @@ apiKnowledgeBasePrice: $ref: '#/apiBillingPrice' type: array type: object +apiLLMSpan: + description: LLM span + properties: + common: + $ref: '#/apiSpanCommon' + model: + example: example string + type: string + num_input_tokens: + example: 123 + format: int32 + type: integer + num_output_tokens: + example: 123 + format: int32 + type: integer + temperature: + example: 123 + format: float + type: number + time_to_first_token_ns: + example: "12345" + format: int64 + type: string + tools: + description: Tool definitions passed to the model + items: + type: object + type: array + total_tokens: + example: 123 + format: int32 + type: integer + type: object apiLinkAgentFunctionInputPublic: description: Information for a agent function link properties: @@ -4607,6 +4678,12 @@ apiRetrievalMethod: - RETRIEVAL_METHOD_NONE example: RETRIEVAL_METHOD_UNKNOWN type: string +apiRetrieverSpan: + description: Retriever span + properties: + common: + $ref: '#/apiSpanCommon' + type: object apiRollbackToAgentVersionInputPublic: properties: uuid: @@ -4751,6 +4828,36 @@ apiSpacesDataSource: example: example string type: string type: object +apiSpanCommon: + description: Common optional fields shared by all span types + properties: + created_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + duration_ns: + example: "12345" + format: int64 + type: string + metadata: + additionalProperties: + example: example string + type: string + description: Arbitrary structured metadata + type: object + status_code: + example: 123 + format: int32 + type: integer + tags: + description: Free-form tags for filtering/grouping + example: + - example string + items: + example: example string + type: string + type: array + type: object apiStarMetric: properties: metric_uuid: @@ -4816,6 +4923,15 @@ apiTeamModelURLOutput: example: example string type: string type: object +apiToolSpan: + description: Tool span + properties: + common: + $ref: '#/apiSpanCommon' + tool_call_id: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object apiTrace: description: Represents a complete trace properties: @@ -4841,8 +4957,10 @@ apiTrace: type: array type: object apiTraceSpan: - description: Represents a span within a trace (e.g., LLM call, function call, etc.) + description: Represents a span within a trace (e.g., LLM call, tool call, etc.) properties: + agent: + $ref: '#/apiAgentSpan' created_at: description: When the span was created example: "2023-01-01T00:00:00Z" @@ -4852,6 +4970,8 @@ apiTraceSpan: description: Input data for the span (flexible structure - can be messages array, string, etc.) type: object + llm: + $ref: '#/apiLLMSpan' name: description: Name/identifier for the span example: example name @@ -4860,8 +4980,14 @@ apiTraceSpan: description: Output data from the span (flexible structure - can be message, string, etc.) type: object + retriever: + $ref: '#/apiRetrieverSpan' + tool: + $ref: '#/apiToolSpan' type: $ref: '#/apiTraceSpanType' + workflow: + $ref: '#/apiWorkflowSpan' type: object apiTraceSpanType: default: TRACE_SPAN_TYPE_UNKNOWN @@ -4871,6 +4997,8 @@ apiTraceSpanType: - TRACE_SPAN_TYPE_LLM - TRACE_SPAN_TYPE_RETRIEVER - TRACE_SPAN_TYPE_TOOL + - TRACE_SPAN_TYPE_AGENT + - TRACE_SPAN_TYPE_WORKFLOW example: TRACE_SPAN_TYPE_UNKNOWN type: string apiTracingServiceJWTOutput: @@ -5234,16 +5362,34 @@ apiUpdateGuardrailOutput: guardrail: $ref: '#/apiGuardrail' type: object +apiUpdateKnowledgeBaseDataSourceInputPublic: + description: Update a data source of a knowledge base with change in chunking algorithm/options + properties: + chunking_algorithm: + $ref: '#/apiChunkingAlgorithm' + chunking_options: + $ref: '#/apiChunkingOptions' + data_source_uuid: + description: Data Source ID (Path Parameter) + example: '"98765432-1234-1234-1234-123456789012"' + type: string + knowledge_base_uuid: + description: Knowledge Base ID (Path Parameter) + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiUpdateKnowledgeBaseDataSourceOutput: + description: Update a data source of a knowledge base with change in chunking algorithm/options + properties: + knowledge_base_data_source: + $ref: '#/apiKnowledgeBaseDataSource' + type: object apiUpdateKnowledgeBaseInputPublic: description: Information about updating a knowledge base properties: database_id: description: The id of the DigitalOcean database this knowledge base will use, - optiona. - example: '"12345678-1234-1234-1234-123456789012"' - type: string - embedding_model_uuid: - description: Identifier for the foundation model. + optional. example: '"12345678-1234-1234-1234-123456789012"' type: string name: @@ -5442,6 +5588,19 @@ apiWebCrawlerDataSource: type: string type: array type: object +apiWorkflowSpan: + description: Workflow span - can contain child spans (agent, llm, tool, retriever) + properties: + common: + $ref: '#/apiSpanCommon' + spans: + description: |- + Child spans - must contain between 1 and 999 spans + Allowed types: agent, llm, tool, retriever (not workflow) + items: + $ref: '#/apiTraceSpan' + type: array + type: object apiWorkspace: properties: agents: @@ -5538,7 +5697,7 @@ protobufNullValue: `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. - The JSON representation for `NullValue` is JSON `null`. + The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value. enum: diff --git a/specification/resources/gen-ai/examples/curl/genai_create_agent_deployment_file_upload_presigned_url.yml b/specification/resources/gen-ai/examples/curl/genai_create_agent_deployment_file_upload_presigned_url.yml new file mode 100644 index 00000000..ad5b4eab --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_create_agent_deployment_file_upload_presigned_url.yml @@ -0,0 +1,12 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspace-deployments/file_upload_presigned_url" \ + -d '{ + "file": { + "file_name": "dataset.csv", + "file_size": 2048 + } + }' diff --git a/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace.yml b/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace.yml new file mode 100644 index 00000000..17e232d2 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace.yml @@ -0,0 +1,16 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces" \ + -d '{ + "agent_workspace_name": "adk", + "agent_deployment_name": "main", + "project_id": "37455431-84bd-4fa2-94cf-e8486f8f8c5e", + "agent_deployment_code_artifact": { + "agent_code_file_path": "config.csv", + "stored_object_key": "123abc", + "size_in_bytes": 255 + } + }' diff --git a/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace_deployment.yml b/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace_deployment.yml new file mode 100644 index 00000000..38604a60 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace_deployment.yml @@ -0,0 +1,14 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk/agent-deployments" \ + -d '{ + "agent_deployment_name": "main", + "agent_deployment_code_artifact": { + "agent_code_file_path": "config.csv", + "stored_object_key": "123abc", + "size_in_bytes": 255 + } + }' diff --git a/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace_deployment_releases.yml b/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace_deployment_releases.yml new file mode 100644 index 00000000..41442e00 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_create_agent_workspace_deployment_releases.yml @@ -0,0 +1,13 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk/agent-deployments/main" \ + -d '{ + "agent_deployment_code_artifact": { + "agent_code_file_path": "config.csv", + "stored_object_key": "123abc", + "size_in_bytes": 255 + } + }' diff --git a/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml b/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml index 4a7775ec..da84148d 100644 --- a/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml +++ b/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml @@ -26,7 +26,7 @@ source: |- }, { "web_crawler_data_source": { - "base_url": "https://example.com", + "base_url": "https://faas-blr1-8177d592.doserverless.co/api/v1/web/fn-a8217bc8-d09f-4751-8686-76c0974bf8cc/default/html-tester", "crawling_option": "SCOPED", "embed_media": false, "exclude_tags": ["nav","footer","header","aside","script","style","form","iframe", "noscript"] @@ -38,14 +38,14 @@ source: |- } }, { - "spaces_data_source": { - "bucket_name": "test-public-gen-ai-2", - "region": "tor1" - }, - "chunking_algorithm": "CHUNKING_ALGORITHM_FIXED_LENGTH", - "chunking_options": { - "max_chunk_size": 400 - } + "spaces_data_source": { + "bucket_name": "test-public-gen-ai-2", + "region": "tor1" + }, + "chunking_algorithm": "CHUNKING_ALGORITHM_FIXED_LENGTH", + "chunking_options": { + "max_chunk_size": 400 + } }, ], "region": "tor1", diff --git a/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml b/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml index 1265e10c..10cf4e3b 100644 --- a/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml +++ b/specification/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml @@ -7,7 +7,7 @@ source: |- -d '{ "knowledge_base_uuid": "20cd8434-6ea1-11f0-bf8f-4e013e2ddde4", "web_crawler_data_source": { - "base_url": "https://example.com", + "base_url": "https://faas-blr1-8177d592.doserverless.co/api/v1/web/fn-a8217bc8-d09f-4751-8686-76c0974bf8cc/default/html-tester", "crawling_option": "SCOPED", "embed_media": false, "exclude_tags": ["nav","footer","header","aside","script","style","form","iframe", "noscript"] diff --git a/specification/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml b/specification/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml deleted file mode 100644 index 6c308921..00000000 --- a/specification/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml +++ /dev/null @@ -1,14 +0,0 @@ -lang: cURL -source: |- - curl --location --request POST 'https://api.digitalocean.com/v2/gen-ai/scheduled-indexing' \ - --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN"' \ - --header 'Content-Type: application/json' \ - --data '{ - "knowledge_base_uuid": "knowledge_base_uuid", - "time": "18:00", - "days": [ - 1, - 2, - 3 - ] - }' \ No newline at end of file diff --git a/specification/resources/gen-ai/examples/curl/genai_delete_agent_workspace.yml b/specification/resources/gen-ai/examples/curl/genai_delete_agent_workspace.yml new file mode 100644 index 00000000..97a85fc0 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_delete_agent_workspace.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk" diff --git a/specification/resources/gen-ai/examples/curl/genai_delete_agent_workspace_deployment.yml b/specification/resources/gen-ai/examples/curl/genai_delete_agent_workspace_deployment.yml new file mode 100644 index 00000000..3ee7b6d1 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_delete_agent_workspace_deployment.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk/agent-deployments/main" diff --git a/specification/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml b/specification/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml deleted file mode 100644 index 0686153c..00000000 --- a/specification/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml +++ /dev/null @@ -1,4 +0,0 @@ -lang: cURL -source: |- - curl --location --request DELETE 'https://api.digitalocean.com/v2/gen-ai/scheduled-indexing/{scheduled_indexing_id}' \ - --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ No newline at end of file diff --git a/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace.yml b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace.yml new file mode 100644 index 00000000..8ed85f06 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk" diff --git a/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment.yml b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment.yml new file mode 100644 index 00000000..559f803c --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk/agent-deployments/main" diff --git a/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment_release.yml b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment_release.yml new file mode 100644 index 00000000..f8388110 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment_release.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspace-deployment-releases/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" diff --git a/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment_runtime_logs.yml b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment_runtime_logs.yml new file mode 100644 index 00000000..a1c5123d --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_get_agent_workspace_deployment_runtime_logs.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk/agent-deployments/main/logs?follow=true&tail_lines=100" diff --git a/specification/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml b/specification/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml index 38252063..f5a29b2d 100644 --- a/specification/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml +++ b/specification/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml @@ -1,5 +1,5 @@ lang: cURL source: |- - curl --location --request GET 'https://api.digitalocean.com/v2/gen-ai/indexing_jobs/6b090372-a8c3-11f0-b542-ca68c578b04b/details_signed_url' \ + curl --location 'https://api.digitalocean.com/v2/gen-ai/indexing_jobs/6b090372-a8c3-11f0-b542-ca68c578b04b/details_signed_url' \ --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ --header 'Content-Type: application/json' \ No newline at end of file diff --git a/specification/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml b/specification/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml deleted file mode 100644 index 7931ebc0..00000000 --- a/specification/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml +++ /dev/null @@ -1,5 +0,0 @@ -lang: cURL -source: |- - curl --location --request GET 'https://api.digitalocean.com/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}' \ - --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ - --header 'Content-Type: application/json' \ No newline at end of file diff --git a/specification/resources/gen-ai/examples/curl/genai_list_agent_workspace_deployment_releases.yml b/specification/resources/gen-ai/examples/curl/genai_list_agent_workspace_deployment_releases.yml new file mode 100644 index 00000000..9e4a9783 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_list_agent_workspace_deployment_releases.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspace-deployments/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/releases" diff --git a/specification/resources/gen-ai/examples/curl/genai_list_agent_workspace_deployments.yml b/specification/resources/gen-ai/examples/curl/genai_list_agent_workspace_deployments.yml new file mode 100644 index 00000000..87f99887 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_list_agent_workspace_deployments.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/agentWorkspace/agent-deployments" diff --git a/specification/resources/gen-ai/examples/curl/genai_list_agent_workspaces.yml b/specification/resources/gen-ai/examples/curl/genai_list_agent_workspaces.yml new file mode 100644 index 00000000..b00b6b8c --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_list_agent_workspaces.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces" diff --git a/specification/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml b/specification/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml index 85e15896..7ffeb6d7 100644 --- a/specification/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml +++ b/specification/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml @@ -1,5 +1,5 @@ lang: cURL source: |- - curl --location --request GET 'https://api.digitalocean.com/v2/gen-ai/knowledge_bases/1139121f-a860-11f0-b542-ca68c578b04b/indexing_jobs' \ + curl --location 'https://api.digitalocean.com/v2/gen-ai/knowledge_bases/1139121f-a860-11f0-b542-ca68c578b04b/indexing_jobs' \ --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ --header 'Content-Type: application/json' \ No newline at end of file diff --git a/specification/resources/gen-ai/examples/curl/genai_update_agent_workspace_deployment.yml b/specification/resources/gen-ai/examples/curl/genai_update_agent_workspace_deployment.yml new file mode 100644 index 00000000..b18b9c88 --- /dev/null +++ b/specification/resources/gen-ai/examples/curl/genai_update_agent_workspace_deployment.yml @@ -0,0 +1,9 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent-workspaces/adk/agent-deployments/main" \ + -d '{ + "log_insights_enabled": true + }' diff --git a/specification/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml b/specification/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml deleted file mode 100644 index 125c2ff1..00000000 --- a/specification/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml +++ /dev/null @@ -1,10 +0,0 @@ -lang: cURL -source: |- - curl -X PUT \ - -H "Content-Type: application/json" \ - -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - "https://api.digitalocean.com/v2/gen-ai/workspaces/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/agents" \ - -d '{ - "workspace_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", - "agent_uuids": ["95ea6652-75ed-11ef-bf8f-4e013e2ddde4", "37455431-84bd-4fa2-94cf-e8486f8f8c5e"] - }' \ No newline at end of file diff --git a/specification/resources/gen-ai/genai_create_agent_deployment_file_upload_presigned_urls.yml b/specification/resources/gen-ai/genai_create_agent_deployment_file_upload_presigned_urls.yml new file mode 100644 index 00000000..dcd966dd --- /dev/null +++ b/specification/resources/gen-ai/genai_create_agent_deployment_file_upload_presigned_urls.yml @@ -0,0 +1,40 @@ +description: To create presigned URLs for agent deployment file upload, send a POST + request to `/v2/gen-ai/agent-workspace-deployments/file_upload_presigned_url`. +operationId: genai_create_agent_deployment_file_upload_presigned_urls +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentDeploymentFileUploadPresignedURLInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentDeploymentFileUploadPresignedURLOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create Presigned URL for Agent Deployment File Upload +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_agent_deployment_file_upload_presigned_urls.yml diff --git a/specification/resources/gen-ai/genai_create_agent_workspace.yml b/specification/resources/gen-ai/genai_create_agent_workspace.yml new file mode 100644 index 00000000..545be256 --- /dev/null +++ b/specification/resources/gen-ai/genai_create_agent_workspace.yml @@ -0,0 +1,41 @@ +description: To create a new agent workspace, send a POST request to `/v2/gen-ai/agent-workspaces`. + The response body contains a JSON object with the newly created agent workspace + object. +operationId: genai_create_agent_workspace +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentWorkspaceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentWorkspaceOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create a Agent Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_agent_workspace.yml diff --git a/specification/resources/gen-ai/genai_create_agent_workspace_deployment.yml b/specification/resources/gen-ai/genai_create_agent_workspace_deployment.yml new file mode 100644 index 00000000..c5c4727e --- /dev/null +++ b/specification/resources/gen-ai/genai_create_agent_workspace_deployment.yml @@ -0,0 +1,49 @@ +description: To create a new agent workspace deployment, send a POST request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments`. + The response body contains a JSON object with the newly created agent workspace + deployment object. +operationId: genai_create_agent_workspace_deployment +parameters: +- description: The name of agent workspace + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentWorkspaceDeploymentInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentWorkspaceDeploymentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create a Agent Workspace Deployment +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_agent_workspace_deployment.yml diff --git a/specification/resources/gen-ai/genai_create_agent_workspace_deployment_release.yml b/specification/resources/gen-ai/genai_create_agent_workspace_deployment_release.yml new file mode 100644 index 00000000..fb5ea14d --- /dev/null +++ b/specification/resources/gen-ai/genai_create_agent_workspace_deployment_release.yml @@ -0,0 +1,57 @@ +description: To create a new agent workspace deployment release, send a POST request + to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}/releases`. + The response body contains a JSON object with the newly created agent workspace + deployment release object. +operationId: genai_create_agent_workspace_deployment_release +parameters: +- description: The name of agent workspace + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +- description: The deployment name + example: '"example string"' + in: path + name: agent_deployment_name + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentDeploymentReleaseInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentDeploymentReleaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create a Agent Workspace Deployment Release +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_agent_workspace_deployment_release.yml diff --git a/specification/resources/gen-ai/genai_create_oauth2_google_tokens.yml b/specification/resources/gen-ai/genai_create_oauth2_google_tokens.yml new file mode 100644 index 00000000..920d4ac2 --- /dev/null +++ b/specification/resources/gen-ai/genai_create_oauth2_google_tokens.yml @@ -0,0 +1,41 @@ +description: To obtain the refresh token, needed for creation of data sources, send + a GET request to `/v2/gen-ai/oauth2/google/tokens`. Pass the code you obtrained + from the oauth flow in the field 'code' +operationId: genai_create_oauth2_google_tokens +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGoogleOauth2GetTokensInput +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGoogleOauth2GetTokensOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Get Oauth2 Google Tokens +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_oauth2_google_tokens.yml diff --git a/specification/resources/gen-ai/genai_create_traces.yml b/specification/resources/gen-ai/genai_create_traces.yml new file mode 100644 index 00000000..d6fe973a --- /dev/null +++ b/specification/resources/gen-ai/genai_create_traces.yml @@ -0,0 +1,39 @@ +description: To create traces, send a POST request to `/v2/gen-ai/traces`. +operationId: genai_create_traces +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateTracesInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateTracesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create Traces +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_traces.yml diff --git a/specification/resources/gen-ai/genai_delete_agent_workspace.yml b/specification/resources/gen-ai/genai_delete_agent_workspace.yml new file mode 100644 index 00000000..d2e396d9 --- /dev/null +++ b/specification/resources/gen-ai/genai_delete_agent_workspace.yml @@ -0,0 +1,42 @@ +description: To delete an agent workspace, send a DELETE request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}`. +operationId: genai_delete_agent_workspace +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteAgentWorkspaceOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete an Agent Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_agent_workspace.yml diff --git a/specification/resources/gen-ai/genai_delete_agent_workspace_deployment.yml b/specification/resources/gen-ai/genai_delete_agent_workspace_deployment.yml new file mode 100644 index 00000000..e5ff0943 --- /dev/null +++ b/specification/resources/gen-ai/genai_delete_agent_workspace_deployment.yml @@ -0,0 +1,49 @@ +description: To delete an agent workspace deployment, send a DELETE request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}`. +operationId: genai_delete_agent_workspace_deployment +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +- description: The name of the deployment + example: '"example string"' + in: path + name: agent_deployment_name + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteAgentWorkspaceDeploymentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete an Agent Workspace Deployment +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_agent_workspace_deployment.yml diff --git a/specification/resources/gen-ai/genai_get_agent_workspace.yml b/specification/resources/gen-ai/genai_get_agent_workspace.yml new file mode 100644 index 00000000..f08f97a0 --- /dev/null +++ b/specification/resources/gen-ai/genai_get_agent_workspace.yml @@ -0,0 +1,43 @@ +description: To retrieve details of an agent workspace, GET request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}`. + The response body is a JSON object containing the agent workspace. +operationId: genai_get_agent_workspace +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAgentWorkspaceOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve an Existing Agent Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_agent_workspace.yml diff --git a/specification/resources/gen-ai/genai_get_agent_workspace_deployment.yml b/specification/resources/gen-ai/genai_get_agent_workspace_deployment.yml new file mode 100644 index 00000000..0c684c55 --- /dev/null +++ b/specification/resources/gen-ai/genai_get_agent_workspace_deployment.yml @@ -0,0 +1,50 @@ +description: To retrieve details of a agent workspace deployment, GET request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}`. + The response body is a JSON object containing the agent workspace deployment +operationId: genai_get_agent_workspace_deployment +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +- description: The name of the deployment + example: '"example string"' + in: path + name: agent_deployment_name + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAgentWorkspaceDeploymentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve an Existing Agent Workspace Deployment +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_agent_workspace_deployment.yml diff --git a/specification/resources/gen-ai/genai_get_agent_workspace_deployment_release.yml b/specification/resources/gen-ai/genai_get_agent_workspace_deployment_release.yml new file mode 100644 index 00000000..8a7761b1 --- /dev/null +++ b/specification/resources/gen-ai/genai_get_agent_workspace_deployment_release.yml @@ -0,0 +1,44 @@ +description: To retrieve details of a agent workspace deployment release, GET request + to `/v2/gen-ai/agent-workspace-deployment-releases/{uuid}`. The response body is + a JSON object containing the agent workspace deployment release +operationId: genai_get_agent_workspace_deployment_release +parameters: +- description: Unique agent deployment release id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAgentDeploymentReleaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve an Existing Agent Workspace Deployment Release +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_agent_workspace_deployment_release.yml diff --git a/specification/resources/gen-ai/genai_get_agent_workspace_deployment_runtime_logs.yml b/specification/resources/gen-ai/genai_get_agent_workspace_deployment_runtime_logs.yml new file mode 100644 index 00000000..f204ea41 --- /dev/null +++ b/specification/resources/gen-ai/genai_get_agent_workspace_deployment_runtime_logs.yml @@ -0,0 +1,62 @@ +description: To get agent workspace deployment runtime logs, send a GET request to + `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}/logs`. +operationId: genai_get_agent_workspace_deployment_runtime_logs +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +- description: The name of the deployment + example: '"example string"' + in: path + name: agent_deployment_name + required: true + schema: + type: string +- description: Whether to follow live logs. + example: true + in: query + name: follow + schema: + type: boolean +- description: Number of log lines to fetch. + example: '"example string"' + in: query + name: tail_lines + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAgentWorkspaceDeploymentRuntimeLogsOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Get Agent Workspace Deployment Runtime Logs +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_agent_workspace_deployment_runtime_logs.yml diff --git a/specification/resources/gen-ai/genai_get_serverless_inference_usage.yml b/specification/resources/gen-ai/genai_get_serverless_inference_usage.yml new file mode 100644 index 00000000..48a84afc --- /dev/null +++ b/specification/resources/gen-ai/genai_get_serverless_inference_usage.yml @@ -0,0 +1,57 @@ +description: To get serverless inference usage, send a GET request to `/v2/genai/models/api_keys/{uuid}/usage`. + Returns usage metrics for the specified serverless inference key within the provided + time range. +operationId: genai_get_serverless_inference_usage +parameters: +- description: Serverless inference key id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +- description: Return all usage data from this date (defaults to 24 hours ago if omitted). + example: '"example string"' + in: query + name: start + schema: + type: string +- description: Return all usage data up to this date, if omitted, will return up to + the current date. + example: '"example string"' + in: query + name: stop + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetServerlessInferenceUsageOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Get Serverless Inference Usage +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_serverless_inference_usage.yml diff --git a/specification/resources/gen-ai/genai_get_tracing_service_jwt_token.yml b/specification/resources/gen-ai/genai_get_tracing_service_jwt_token.yml new file mode 100644 index 00000000..5670af63 --- /dev/null +++ b/specification/resources/gen-ai/genai_get_tracing_service_jwt_token.yml @@ -0,0 +1,49 @@ +description: To get a JWT token for the tracing service, send a GET request to `/v2/gen-ai/tracing_tokens/{agent_workspace_uuid}/{agent_deployment_name}`. +operationId: genai_get_tracing_service_jwt_token +parameters: +- description: Agent workspace uuid + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_workspace_uuid + required: true + schema: + type: string +- description: Agent deployment name + example: '"example string"' + in: path + name: agent_deployment_name + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiTracingServiceJWTOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Get Tracing Service JWT Token +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_tracing_service_jwt_token.yml diff --git a/specification/resources/gen-ai/genai_list_agent_workspace_deployment_releases.yml b/specification/resources/gen-ai/genai_list_agent_workspace_deployment_releases.yml new file mode 100644 index 00000000..88a2aaf5 --- /dev/null +++ b/specification/resources/gen-ai/genai_list_agent_workspace_deployment_releases.yml @@ -0,0 +1,43 @@ +description: To list all agent workspace deployment releases, send a GET request to + `/v2/gen-ai/agent-workspace-deployments/{agent_deployment_uuid}/releases`. +operationId: genai_list_agent_workspace_deployment_releases +parameters: +- description: The id of the deployment + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_deployment_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentDeploymentReleasesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Agent Workspace Deployment Releases +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agent_workspace_deployment_releases.yml diff --git a/specification/resources/gen-ai/genai_list_agent_workspace_deployments.yml b/specification/resources/gen-ai/genai_list_agent_workspace_deployments.yml new file mode 100644 index 00000000..189298fd --- /dev/null +++ b/specification/resources/gen-ai/genai_list_agent_workspace_deployments.yml @@ -0,0 +1,43 @@ +description: To retrieve all agent workspace deployments, GET request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments`. + The response body is a JSON object containing all deployments from an agent workspace. +operationId: genai_list_agent_workspace_deployments +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentWorkspaceDeploymentsOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve all Deployments from an Agent Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agent_workspace_deployments.yml diff --git a/specification/resources/gen-ai/genai_list_agent_workspaces.yml b/specification/resources/gen-ai/genai_list_agent_workspaces.yml new file mode 100644 index 00000000..4f16954a --- /dev/null +++ b/specification/resources/gen-ai/genai_list_agent_workspaces.yml @@ -0,0 +1,34 @@ +description: To list all agent workspaces, send a GET request to `/v2/gen-ai/agent-workspaces`. +operationId: genai_list_agent_workspaces +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentWorkspacesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Agent Workspaces +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agent_workspaces.yml diff --git a/specification/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml b/specification/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml index a9c355de..a269befa 100644 --- a/specification/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml +++ b/specification/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml @@ -9,6 +9,12 @@ parameters: required: true schema: type: string +- description: Workspace name. + example: '"example string"' + in: query + name: agent_workspace_name + schema: + type: string responses: "200": content: diff --git a/specification/resources/gen-ai/genai_update_agent_workspace_deployment.yml b/specification/resources/gen-ai/genai_update_agent_workspace_deployment.yml new file mode 100644 index 00000000..f69df907 --- /dev/null +++ b/specification/resources/gen-ai/genai_update_agent_workspace_deployment.yml @@ -0,0 +1,55 @@ +description: To update an agent workspace deployment, send a PUT request to `/v2/gen-ai/agent-workspaces/{agent_workspace_name}/agent-deployments/{agent_deployment_name}`. + The response body is a JSON object containing the agent workspace deployment. +operationId: genai_update_agent_workspace_deployment +parameters: +- description: Unique agent workspace name + example: '"example string"' + in: path + name: agent_workspace_name + required: true + schema: + type: string +- description: The name of the deployment + example: '"example string"' + in: path + name: agent_deployment_name + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentWorkspaceDeploymentInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentWorkspaceDeploymentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update an Agent Workspace Deployment +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_agent_workspace_deployment.yml diff --git a/specification/resources/gen-ai/genai_update_knowledge_base_data_source.yml b/specification/resources/gen-ai/genai_update_knowledge_base_data_source.yml new file mode 100644 index 00000000..23ac2b22 --- /dev/null +++ b/specification/resources/gen-ai/genai_update_knowledge_base_data_source.yml @@ -0,0 +1,55 @@ +description: To update a data source (e.g. chunking options), send a PUT request to + `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}`. +operationId: genai_update_knowledge_base_data_source +parameters: +- description: Knowledge Base ID (Path Parameter) + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +- description: Data Source ID (Path Parameter) + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: data_source_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateKnowledgeBaseDataSourceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateKnowledgeBaseDataSourceOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update Data Source options +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_knowledge_base_data_source.yml