Interface QuestionsAPI

interface QuestionsAPI {
    askQuestions: (
        body: QueryCreate,
        options?: ApiCallOptions,
    ) => Promise<AskQuestionsHttpResponse>;
    clearCache: () => void;
    filterQuestions: (
        query: {
            limit?: number;
            page?: string;
            sort?:
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
                | "createdAt"
                | "updatedAt";
        },
        body: NLMetricsRequest,
        options?: ApiCallOptions,
    ) => Promise<FilterQuestionsHttpResponse>;
}
Index

Properties

askQuestions clearCache filterQuestions

Properties

askQuestions: (
    body: QueryCreate,
    options?: ApiCallOptions,
) => Promise<AskQuestionsHttpResponse>

Returns the generated response for parsed chat queries, if no app was specified nor present in conversation context, suggests matching apps.

Type declaration

Param: body

an object with the body content

AskQuestionsHttpError

clearCache: () => void

Clears the cache for questions api requests.

Type declaration

    • (): void

    • Clears the cache for questions api requests.

      Returns void

filterQuestions: (
    query: {
        limit?: number;
        page?: string;
        sort?:
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "createdAt"
            | "updatedAt";
    },
    body: NLMetricsRequest,
    options?: ApiCallOptions,
) => Promise<FilterQuestionsHttpResponse>

Returns NL metrics based on provided app IDs the user has access to.

Type declaration

    • (
          query: {
              limit?: number;
              page?: string;
              sort?:
                  | "+createdAt"
                  | "-createdAt"
                  | "+updatedAt"
                  | "-updatedAt"
                  | "createdAt"
                  | "updatedAt";
          },
          body: NLMetricsRequest,
          options?: ApiCallOptions,
      ): Promise<FilterQuestionsHttpResponse>

    • Returns NL metrics based on provided app IDs the user has access to.

      Parameters

      • query: {
            limit?: number;
            page?: string;
            sort?:
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
                | "createdAt"
                | "updatedAt";
        }

        an object with query parameters

        • Optionallimit?: number

          The preferred number of entries returned

        • Optionalpage?: string

          A cursor pointing to the page of data to retrieve.

        • Optionalsort?:
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
              | "createdAt"
              | "updatedAt"

          A single field from the data model on which to sort the response. The '+' or '-' operator may be used to specify ascending or desending order.

      • body: NLMetricsRequest

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<FilterQuestionsHttpResponse>

      FilterQuestionsHttpError

an object with query parameters

Param: body

an object with the body content

FilterQuestionsHttpError

Settings

Member Visibility

On This Page

Properties