npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@squiz/dxp-ai-client

v0.25.0

Published

Exposes the DXP AI service as a package for consumers

Downloads

6,907

Readme

DXP AI SERVICE CLIENT LIB

Overview

The @squiz/dxp-ai-client is auto generated client library designed to simplify the interactions with the dxp-ai-service

Purpose

  • Abstract away the complexity of HTTP requests and API interactions, allowing other services to interact with the dxp-ai-service service with less effort.
  • Provide a consistent and intuitive API interface, enabling developers to integrate with the dxp-ai-service service efficiently and not waste time updating their own integration services.

Usage

To utilize the Main Service Client Library within your service, follow these steps:

  1. Installation: Install the client library package in your service's environment using your preferred package manager (e.g. npm , pnpm or yarn).
npm install @squiz/dxp-ai-client
  1. Initialize Client: Initialize an instance of the dxp-ai-service client within your service's codebase, providing any required configuration parameters. The following example is from the DXP console

     export class AiService extends BaseService {
       public readonly apiClient: DxpAiService<unknown>;
       public constructor(configuration: AiServiceConfiguration) {
         super(configuration);
         const baseUrl = this.getServiceUrlByTenant('ai');
         if (!baseUrl) {
           throw new Error('BaseUrl is undefined');
         }
         const httpClient = createClient({
           baseUrl: baseUrl,
         });
         this.apiClient = new DxpAiService(httpClient);
       }
     }
  2. Interact with Main Service: Once initialized, you can start making requests to the dxp-ai-service service using the methods exposed by the client library. These methods abstract away the underlying HTTP requests and provide a simple interface for interacting with the dxp-ai-service service's endpoints.

    aiService.apiClient.generative.list(query)
        .then((user) => {
            // Handle ai data
        })
        .catch((error) => {
            // Handle error
        });
           
  3. Contribute and Extend: If your service requires changes to the package generation settings or extension in its interaction with the dxp-ai-service service (requiring changes to the service code). Please see the Contribution guidelines