Updated the docs (#1117)

* Updated the docs

* Fxi

* fix

Author: chandrudo

specification/resources/gen-ai/definitions.yml

@@ -350,10 +350,6 @@ apiAgentDeploymentRelease:
       example: "2023-01-01T00:00:00Z"
       format: date-time
       type: string
-    url:
-      description: The url to access the agent workspace deployment
-      example: example string
-      type: string
     uuid:
       description: Unique release id
       example: 123e4567-e89b-12d3-a456-426614174000
@@ -1194,12 +1190,14 @@ apiCrawlingOption:
      - PATH: Crawl the base URL and linked pages within the URL path.
      - DOMAIN: Crawl the base URL and linked pages within the same domain.
      - SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
+     - SITEMAP: Crawl URLs discovered in the sitemap.
   enum:
   - UNKNOWN
   - SCOPED
   - PATH
   - DOMAIN
   - SUBDOMAINS
+  - SITEMAP
   example: UNKNOWN
   type: string
 apiCreateAgentAPIKeyInputPublic:
@@ -1218,6 +1216,12 @@ apiCreateAgentAPIKeyOutput:
     api_key_info:
       $ref: '#/apiAgentAPIKeyInfo'
   type: object
+apiCreateAgentDeploymentFileUploadPresignedURLInputPublic:
+  description: Request for pre-signed URL's to upload file for Agent Workspace
+  properties:
+    file:
+      $ref: '#/apiPresignedUrlFile'
+  type: object
 apiCreateAgentDeploymentFileUploadPresignedURLOutput:
   description: Response with pre-signed url to upload file
   properties:
@@ -1228,6 +1232,19 @@ apiCreateAgentDeploymentFileUploadPresignedURLOutput:
     upload:
       $ref: '#/apiFilePresignedUrlResponse'
   type: object
+apiCreateAgentDeploymentReleaseInputPublic:
+  properties:
+    agent_deployment_code_artifact:
+      $ref: '#/apiAgentDeploymentCodeArtifact'
+    agent_deployment_name:
+      description: The deployment name
+      example: example name
+      type: string
+    agent_workspace_name:
+      description: The name of agent workspace
+      example: example name
+      type: string
+  type: object
 apiCreateAgentDeploymentReleaseOutput:
   description: One Agent Deployment Release
   properties:
@@ -1326,12 +1343,42 @@ apiCreateAgentOutput:
     agent:
       $ref: '#/apiAgent'
   type: object
+apiCreateAgentWorkspaceDeploymentInputPublic:
+  properties:
+    agent_deployment_code_artifact:
+      $ref: '#/apiAgentDeploymentCodeArtifact'
+    agent_deployment_name:
+      description: The deployment name
+      example: example name
+      type: string
+    agent_workspace_name:
+      description: The name of agent workspace
+      example: example name
+      type: string
+  type: object
 apiCreateAgentWorkspaceDeploymentOutput:
   description: One Agent Workspace Deployment
   properties:
     agent_workspace_deployment:
       $ref: '#/apiAgentWorkspaceDeployment'
   type: object
+apiCreateAgentWorkspaceInputPublic:
+  properties:
+    agent_deployment_code_artifact:
+      $ref: '#/apiAgentDeploymentCodeArtifact'
+    agent_deployment_name:
+      description: The deployment name
+      example: example name
+      type: string
+    agent_workspace_name:
+      description: The name of agent workspace
+      example: example name
+      type: string
+    project_id:
+      description: The project id
+      example: 123e4567-e89b-12d3-a456-426614174000
+      type: string
+  type: object
 apiCreateAgentWorkspaceOutput:
   properties:
     agent_workspace:
@@ -1624,6 +1671,10 @@ apiCreateTracesInputPublic:
 apiCreateTracesOutput:
   description: Output for creating traces
   properties:
+    session_id:
+      description: Session ID
+      example: 123e4567-e89b-12d3-a456-426614174000
+      type: string
     trace_uuids:
       description: Trace UUIDs created
       example:
@@ -1701,6 +1752,20 @@ apiDeleteAgentOutput:
     agent:
       $ref: '#/apiAgent'
   type: object
+apiDeleteAgentWorkspaceDeploymentOutput:
+  properties:
+    agent_workspace_deployment_uuid:
+      description: The agent workspace deployment id
+      example: 123e4567-e89b-12d3-a456-426614174000
+      type: string
+  type: object
+apiDeleteAgentWorkspaceOutput:
+  properties:
+    agent_workspace_name:
+      description: The agent workspace name
+      example: example name
+      type: string
+  type: object
 apiDeleteAnthropicAPIKeyInputPublic:
   properties:
     api_key_uuid:
@@ -1937,6 +2002,8 @@ apiEvaluationDataset:
   type: object
 apiEvaluationMetric:
   properties:
+    category:
+      $ref: '#/apiEvaluationMetricCategory'
     description:
       example: example string
       type: string
@@ -1945,9 +2012,16 @@ apiEvaluationMetric:
         better.
       example: true
       type: boolean
+    is_metric_goal:
+      example: true
+      type: boolean
     metric_name:
       example: example name
       type: string
+    metric_rank:
+      example: 123
+      format: int64
+      type: integer
     metric_type:
       $ref: '#/apiEvaluationMetricType'
     metric_uuid:
@@ -1966,6 +2040,17 @@ apiEvaluationMetric:
       format: float
       type: number
   type: object
+apiEvaluationMetricCategory:
+  default: METRIC_CATEGORY_UNSPECIFIED
+  enum:
+  - METRIC_CATEGORY_UNSPECIFIED
+  - METRIC_CATEGORY_CORRECTNESS
+  - METRIC_CATEGORY_USER_OUTCOMES
+  - METRIC_CATEGORY_SAFETY_AND_SECURITY
+  - METRIC_CATEGORY_CONTEXT_QUALITY
+  - METRIC_CATEGORY_MODEL_FIT
+  example: METRIC_CATEGORY_UNSPECIFIED
+  type: string
 apiEvaluationMetricResult:
   properties:
     error_description:
@@ -2350,6 +2435,13 @@ apiGetAgentWorkspaceDeploymentOutput:
     agent_workspace_deployment:
       $ref: '#/apiAgentWorkspaceDeployment'
   type: object
+apiGetAgentWorkspaceDeploymentRuntimeLogsOutput:
+  properties:
+    live_url:
+      description: URL for live logs
+      example: example string
+      type: string
+  type: object
 apiGetAgentWorkspaceOutput:
   description: One Agent Workspace
   properties:
@@ -2830,6 +2922,7 @@ apiIndexJobStatus:
   - INDEX_JOB_STATUS_FAILED
   - INDEX_JOB_STATUS_NO_CHANGES
   - INDEX_JOB_STATUS_PENDING
+  - INDEX_JOB_STATUS_CANCELLED
   example: INDEX_JOB_STATUS_UNKNOWN
   type: string
 apiIndexedDataSource:
@@ -2967,26 +3060,6 @@ apiIndexingJob:
       example: 123
       format: int64
       type: integer
-    total_items_failed:
-      description: Total Items Failed
-      example: "12345"
-      format: uint64
-      type: string
-    total_items_indexed:
-      description: Total Items Indexed
-      example: "12345"
-      format: uint64
-      type: string
-    total_items_removed:
-      description: Total Items Removed
-      example: "12345"
-      format: uint64
-      type: string
-    total_items_skipped:
-      description: Total Items Skipped
-      example: "12345"
-      format: uint64
-      type: string
     total_tokens:
       description: Total Tokens Consumed By the Indexing Job
       example: "12345"
@@ -3135,8 +3208,6 @@ apiKnowledgeBaseDataSource:
       type: string
     last_datasource_indexing_job:
       $ref: '#/apiIndexedDataSource'
-    last_indexing_job:
-      $ref: '#/apiIndexingJob'
     region:
       description: Region code - Deprecated, moved to data_source_details
       example: example string
@@ -4327,6 +4398,7 @@ apiReleaseStatus:
      - RELEASE_STATUS_UNDEPLOYING: the release is currently being undeployed
      - RELEASE_STATUS_UNDEPLOYMENT_FAILED: the release undeployment failed
      - RELEASE_STATUS_DELETED: the release has been deleted
+     - RELEASE_STATUS_BUILDING: the release is building
   enum:
   - RELEASE_STATUS_UNKNOWN
   - RELEASE_STATUS_WAITING_FOR_DEPLOYMENT
@@ -4337,6 +4409,7 @@ apiReleaseStatus:
   - RELEASE_STATUS_UNDEPLOYING
   - RELEASE_STATUS_UNDEPLOYMENT_FAILED
   - RELEASE_STATUS_DELETED
+  - RELEASE_STATUS_BUILDING
   example: RELEASE_STATUS_UNKNOWN
   type: string
 apiResourceUsage:
@@ -4884,6 +4957,26 @@ apiUpdateAgentOutput:
     agent:
       $ref: '#/apiAgent'
   type: object
+apiUpdateAgentWorkspaceDeploymentInputPublic:
+  properties:
+    agent_deployment_name:
+      description: The name of the deployment
+      example: example name
+      type: string
+    agent_workspace_name:
+      description: Unique agent workspace name
+      example: example name
+      type: string
+    log_insights_enabled:
+      example: true
+      type: boolean
+  type: object
+apiUpdateAgentWorkspaceDeploymentOutput:
+  description: One Agent Workspace Deployment
+  properties:
+    agent_workspace_deployment:
+      $ref: '#/apiAgentWorkspaceDeployment'
+  type: object
 apiUpdateAnthropicAPIKeyInputPublic:
   description: UpdateAnthropicAPIKeyInputPublic is used to update an existing Anthropic
     API key for a specific agent.

specification/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml

@@ -14,15 +14,17 @@ source: |-
       "database_id": "abf1055a-745d-4c24-a1db-1959ea819264",
       "datasources": [
         {
-          "bucket_name": "test-public-gen-ai",
-          "bucket_region": "tor1"
+            "spaces_data_source": {
+                "bucket_name": "test-public-gen-ai",
+                "region": "tor1"
+              }
         },
         {
           "web_crawler_data_source": {
             "base_url": "https://example.com",
             "crawling_option": "SCOPED",
             "embed_media": false,
-            "exclude_tags":["footer", "title", "h1"]
+            "exclude_tags": ["nav","footer","header","aside","script","style","form","iframe", "noscript"]
           }
         }
       ],

specification/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml

@@ -10,6 +10,6 @@ source: |-
     "base_url": "https://example.com",
     "crawling_option": "SCOPED",
     "embed_media": false,
-    "exclude_tags": ["h1", "section"]
+    "exclude_tags": ["nav","footer","header","aside","script","style","form","iframe", "noscript"]
   }
   }'