@markupai/api 1.1.0 → 1.3.0

package/dist/esm/api/resources/terminology/client/Client.d.mts

@@ -0,0 +1,333 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as MarkupAI from "../../../index.mjs";
+export declare namespace Terminology {
+    interface Options {
+        environment?: core.Supplier<environments.MarkupAIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+/**
+ * Manage term sets and terms.
+ */
+export declare class Terminology {
+    protected readonly _options: Terminology.Options;
+    constructor(_options: Terminology.Options);
+    /**
+     * Exports all term sets, terms and domains to CSV. The exported CSV follows the same format as the CSV import.
+     *
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.exportTerminology()
+     */
+    exportTerminology(requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __exportTerminology;
+    /**
+     * Uploads a CSV or ACTIF XML file and imports terminology.
+     *
+     * **CSV Format Requirements:**
+     * - CSV must include columns: Prohibited, Preferred, Context-Dependent, Instructions, Domains
+     * - The first row must contain the column headers in the exact same order as shown above
+     * - Multiple values within a single cell should be separated by semicolons with a space (e.g., term1; term2; term3)
+     * - Empty cells are allowed
+     * - The CSV import format is the same as the CSV export format.
+     *
+     * @param {MarkupAI.BodyTerminologyImportTerminology} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.terminology.importTerminology({
+     *         file: fs.createReadStream("/path/to/your/file"),
+     *         delete_existing: true
+     *     })
+     */
+    importTerminology(request: MarkupAI.BodyTerminologyImportTerminology, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.ImportSummary>;
+    private __importTerminology;
+    /**
+     * Searches the text for relevant terminology and returns matched term sets.
+     *
+     * Term sets are matched if any word sequence (up to 5 words) in the text is similar to one of the terms of the term set.
+     * The similarity measure used is a trigram similarity of 0.5 or higher between the word sequence and the term.
+     *
+     * @param {MarkupAI.TerminologySearchTerminologyRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.searchTerminology({
+     *         query: "query"
+     *     })
+     */
+    searchTerminology(request: MarkupAI.TerminologySearchTerminologyRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TerminologySearchResponse>;
+    private __searchTerminology;
+    /**
+     * Get a pageable list of term sets with all their associated terms and domains.
+     *
+     * The search filter searches the term set instructions and term text fields.
+     *
+     * @param {MarkupAI.TerminologyListTermSetsRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.listTermSets({
+     *         page: 1,
+     *         page_size: 1,
+     *         search_term: "search_term"
+     *     })
+     */
+    listTermSets(request?: MarkupAI.TerminologyListTermSetsRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.PaginatedTermSetsResponse>;
+    private __listTermSets;
+    /**
+     * Create a new term set. Terms and domains are linked to term sets.
+     * The term set instructions text will be used to determine whether a term should be flagged in the text and what the term replacement should be.
+     *
+     * @param {MarkupAI.TermSetCreateRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.createTermSet({
+     *         instructions: "instructions"
+     *     })
+     */
+    createTermSet(request: MarkupAI.TermSetCreateRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TermSetResponse>;
+    private __createTermSet;
+    /**
+     * @param {string} termSetId - UUID of the term set
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.getTermSet("term_set_id")
+     */
+    getTermSet(termSetId: string, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TermSetWithTerms>;
+    private __getTermSet;
+    /**
+     * @param {string} termSetId - UUID of the term set
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.deleteTermSet("term_set_id")
+     */
+    deleteTermSet(termSetId: string, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteTermSet;
+    /**
+     * @param {string} termSetId - UUID of the term set
+     * @param {MarkupAI.TermSetUpdateRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.updateTermSet("term_set_id")
+     */
+    updateTermSet(termSetId: string, request?: MarkupAI.TermSetUpdateRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TermSetResponse>;
+    private __updateTermSet;
+    /**
+     * Create terms that should be matched in the text. The term types are:
+     *
+     * * **preferred**: this is the preferred term for the associated term set
+     * * **prohibited**: this term should not be used to talk about the term set
+     * * **context_dependent**: this term is correct in certain cases, but incorrect in others, the instructions field of the term set should explain when the term is correct and when it is incorrect
+     *
+     * @param {string} termSetId - UUID of the term set
+     * @param {MarkupAI.TermCreateRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.createTerm("term_set_id", {
+     *         term: "term",
+     *         type: "preferred"
+     *     })
+     */
+    createTerm(termSetId: string, request: MarkupAI.TermCreateRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TermResponse>;
+    private __createTerm;
+    /**
+     * @param {string} termSetId - UUID of the term set
+     * @param {string} termId - UUID of the term
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.getTerm("term_set_id", "term_id")
+     */
+    getTerm(termSetId: string, termId: string, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TermResponse>;
+    private __getTerm;
+    /**
+     * @param {string} termSetId - UUID of the term set
+     * @param {string} termId - UUID of the term
+     * @param {MarkupAI.TermUpdateRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.updateTerm("term_set_id", "term_id", {
+     *         term: "term",
+     *         type: "preferred"
+     *     })
+     */
+    updateTerm(termSetId: string, termId: string, request: MarkupAI.TermUpdateRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.TermResponse>;
+    private __updateTerm;
+    /**
+     * @param {string} termSetId - UUID of the term set
+     * @param {string} termId - UUID of the term
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.deleteTerm("term_set_id", "term_id")
+     */
+    deleteTerm(termSetId: string, termId: string, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteTerm;
+    /**
+     * @param {MarkupAI.TerminologyListDomainsRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.listDomains({
+     *         page: 1,
+     *         page_size: 1,
+     *         search: "search"
+     *     })
+     */
+    listDomains(request?: MarkupAI.TerminologyListDomainsRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.PaginatedDomainsResponse>;
+    private __listDomains;
+    /**
+     * @param {MarkupAI.DomainCreateRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.createDomain({
+     *         name: "name"
+     *     })
+     */
+    createDomain(request: MarkupAI.DomainCreateRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.DomainResponse>;
+    private __createDomain;
+    /**
+     * @param {string} domainId - UUID of the domain
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.getDomain("domain_id")
+     */
+    getDomain(domainId: string, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.DomainResponse>;
+    private __getDomain;
+    /**
+     * @param {string} domainId - UUID of the domain
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.deleteDomain("domain_id")
+     */
+    deleteDomain(domainId: string, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteDomain;
+    /**
+     * @param {string} domainId - UUID of the domain
+     * @param {MarkupAI.DomainUpdateRequest} request
+     * @param {Terminology.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MarkupAI.UnauthorizedError}
+     * @throws {@link MarkupAI.ForbiddenError}
+     * @throws {@link MarkupAI.UnprocessableEntityError}
+     * @throws {@link MarkupAI.InternalServerError}
+     *
+     * @example
+     *     await client.terminology.updateDomain("domain_id")
+     */
+    updateDomain(domainId: string, request?: MarkupAI.DomainUpdateRequest, requestOptions?: Terminology.RequestOptions): core.HttpResponsePromise<MarkupAI.DomainResponse>;
+    private __updateDomain;
+    protected _getAuthorizationHeader(): Promise<string>;
+}