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

    Variable ScenarioConfigurationManagerApiConst

    ScenarioConfigurationManagerApi: {
        _defaultBasePath: string;
        createScenarioConfiguration: (
            scenarioConfigurationName: string,
            body: CreateScenarioConfiguration,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<ScenarioConfigurationNameObject>;
        deleteScenarioConfigurationByName: (
            scenarioConfigurationName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<any>;
        getAllScenarioConfigurations: (
            queryParameters: { $count?: boolean; $skip?: number; $top?: number },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<GetScenarioConfigurations>;
        getScenarioConfigurationByName: (
            scenarioConfigurationName: string,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<ScenarioConfigurationObject>;
        patchScenarioConfigurationByName: (
            scenarioConfigurationName: string,
            body: PatchScenarioConfiguration,
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<any>;
        searchScenarioConfigurationsByLabel: (
            body: SearchScenarioConfiguration,
            queryParameters: { $count?: boolean; $skip?: number; $top?: number },
            headerParameters: { "AI-Resource-Group": string },
        ) => OpenApiRequestBuilder<GetScenarioConfigurations>;
    }

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

    Type Declaration

    • _defaultBasePath: string
    • createScenarioConfiguration: (
          scenarioConfigurationName: string,
          body: CreateScenarioConfiguration,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<ScenarioConfigurationNameObject>

      Create a scenario configuration asynchronously. Schema validation happens synchronously; background processing runs asynchronously. Poll GET /scenarioConfigurations/{name} to track progress via status and errorMessage. Returns 202 (not exists or ERROR retry), 409 (ACTIVE or DELETING), 422 (retry exhausted).

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

      Delete a scenario configuration by name

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

      Get all scenario configurations in the tenant (resource group)

    • getScenarioConfigurationByName: (
          scenarioConfigurationName: string,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<ScenarioConfigurationObject>

      Get a scenario configuration by its name

    • patchScenarioConfigurationByName: (
          scenarioConfigurationName: string,
          body: PatchScenarioConfiguration,
          headerParameters: { "AI-Resource-Group": string },
      ) => OpenApiRequestBuilder<any>

      Update a scenario configuration (excluding name)

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

      Search for scenario configurations that match ALL specified labels (AND logic)