Socket
Socket
Sign inDemoInstall

@aws-sdk/client-qconnect

Package Overview
Dependencies
136
Maintainers
5
Versions
63
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @aws-sdk/client-qconnect

AWS SDK for JavaScript Qconnect Client for Node.js, Browser and React Native


Version published
Weekly downloads
463
increased by47.92%
Maintainers
5
Created
Weekly downloads
 

Readme

Source

@aws-sdk/client-qconnect

Description

AWS SDK for JavaScript QConnect Client for Node.js, Browser and React Native.

Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).

Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.

Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.

Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.

Installing

To install the this package, simply type add or install @aws-sdk/client-qconnect using your favorite package manager:

  • npm install @aws-sdk/client-qconnect
  • yarn add @aws-sdk/client-qconnect
  • pnpm add @aws-sdk/client-qconnect

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the QConnectClient and the commands you need, for example ListAssistantsCommand:

// ES5 example
const { QConnectClient, ListAssistantsCommand } = require("@aws-sdk/client-qconnect");
// ES6+ example
import { QConnectClient, ListAssistantsCommand } from "@aws-sdk/client-qconnect";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new QConnectClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListAssistantsCommand(params);
Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });
Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});
v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-qconnect";
const client = new AWS.QConnect({ region: "REGION" });

// async/await.
try {
  const data = await client.listAssistants(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listAssistants(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listAssistants(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-qconnect package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateAssistant

Command API Reference / Input / Output

CreateAssistantAssociation

Command API Reference / Input / Output

CreateContent

Command API Reference / Input / Output

CreateKnowledgeBase

Command API Reference / Input / Output

CreateQuickResponse

Command API Reference / Input / Output

CreateSession

Command API Reference / Input / Output

DeleteAssistant

Command API Reference / Input / Output

DeleteAssistantAssociation

Command API Reference / Input / Output

DeleteContent

Command API Reference / Input / Output

DeleteImportJob

Command API Reference / Input / Output

DeleteKnowledgeBase

Command API Reference / Input / Output

DeleteQuickResponse

Command API Reference / Input / Output

GetAssistant

Command API Reference / Input / Output

GetAssistantAssociation

Command API Reference / Input / Output

GetContent

Command API Reference / Input / Output

GetContentSummary

Command API Reference / Input / Output

GetImportJob

Command API Reference / Input / Output

GetKnowledgeBase

Command API Reference / Input / Output

GetQuickResponse

Command API Reference / Input / Output

GetRecommendations

Command API Reference / Input / Output

GetSession

Command API Reference / Input / Output

ListAssistantAssociations

Command API Reference / Input / Output

ListAssistants

Command API Reference / Input / Output

ListContents

Command API Reference / Input / Output

ListImportJobs

Command API Reference / Input / Output

ListKnowledgeBases

Command API Reference / Input / Output

ListQuickResponses

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

NotifyRecommendationsReceived

Command API Reference / Input / Output

PutFeedback

Command API Reference / Input / Output

QueryAssistant

Command API Reference / Input / Output

RemoveKnowledgeBaseTemplateUri

Command API Reference / Input / Output

SearchContent

Command API Reference / Input / Output

SearchQuickResponses

Command API Reference / Input / Output

SearchSessions

Command API Reference / Input / Output

StartContentUpload

Command API Reference / Input / Output

StartImportJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateContent

Command API Reference / Input / Output

UpdateKnowledgeBaseTemplateUri

Command API Reference / Input / Output

UpdateQuickResponse

Command API Reference / Input / Output

UpdateSession

Command API Reference / Input / Output

FAQs

Last updated on 18 Jun 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc