SAP AI SDK for JavaScript - v2.17.0
    Preparing search index...

    Variable TabularArtifactsApiConst

    TabularArtifactsApi: {
        _defaultBasePath: string;
        createTabularArtifact: (
            tabularArtifactName: string,
            body: CreateTARequest,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<{ name?: string }>;
        deleteTabularArtifact: (
            tabularArtifactName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<any>;
        getAllTabularArtifacts: (
            queryParameters: { $count?: boolean; $skip?: number; $top?: number },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<TabularArtifactListResponse>;
        getTabularArtifactByName: (
            tabularArtifactName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<TabularArtifactDetails>;
        getTabularArtifactData: (
            tabularArtifactName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<TabularArtifactDataPreview>;
    }

    Representation of the 'TabularArtifactsApi'. This API is part of the 'context-registry' service.

    Type Declaration

    • _defaultBasePath: string
    • createTabularArtifact: (
          tabularArtifactName: string,
          body: CreateTARequest,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<{ name?: string }>

      Create a Tabular Artifact asynchronously. Schema validation happens synchronously; resource creation runs in a background task. Poll GET /tabularArtifacts/{name} to track progress via status and errorMessage. Returns 202 (not exists or ERROR retry), 409 (ACTIVE or DELETING), 422 (retry exhausted).

    • deleteTabularArtifact: (
          tabularArtifactName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<any>

      Delete a specific Tabular Artifact by name

    • getAllTabularArtifacts: (
          queryParameters: { $count?: boolean; $skip?: number; $top?: number },
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<TabularArtifactListResponse>

      Retrieve list of Tabular Artifacts with pagination

    • getTabularArtifactByName: (
          tabularArtifactName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<TabularArtifactDetails>

      Retrieve details of a specific Tabular Artifact by name including schema metadata.

    • getTabularArtifactData: (
          tabularArtifactName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<TabularArtifactDataPreview>

      Retrieve a preview of data rows from the Virtual Table (first 10 records)