Llm.Classify

Overview

Available Operations

• classify - Classify text into predefined categories

classify

Classifies text content into one of the provided predefined labels.

Example Usage

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.llm.classify.classify({
    model: "meetkai:functionary-urdu-mini-pak",
    text: "I absolutely love this product! Best purchase ever.",
    labels: [
      "positive",
      "negative",
      "neutral",
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SDKCore } from "@meetkai/mka1/core.js";
import { llmClassifyClassify } from "@meetkai/mka1/funcs/llmClassifyClassify.js";

// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await llmClassifyClassify(sdk, {
    model: "meetkai:functionary-urdu-mini-pak",
    text: "I absolutely love this product! Best purchase ever.",
    labels: [
      "positive",
      "negative",
      "neutral",
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("llmClassifyClassify failed:", res.error);
  }
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useLlmClassifyClassifyMutation
} from "@meetkai/mka1/react-query/llmClassifyClassify.js";

Parameters

Parameter	Type	Required	Description
request	components.ClassificationRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ClassificationResponse>

Errors

Error Type	Status Code	Content Type
errors.APIError	4XX, 5XX	*/*