@vectorize-io/vectorize-client/dist/models/RetrieveDocumentsRequest.d.ts

Client for the Vectorize API

/**
 * Vectorize API (Beta)
 * API for Vectorize services
 *
 * The version of the OpenAPI document: 0.0.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { RetrieveContext } from './RetrieveContext';
import type { AdvancedQuery } from './AdvancedQuery';
/**
 *
 * @export
 * @interface RetrieveDocumentsRequest
 */
export interface RetrieveDocumentsRequest {
    /**
     *
     * @type {string}
     * @memberof RetrieveDocumentsRequest
     */
    question: string;
    /**
     *
     * @type {number}
     * @memberof RetrieveDocumentsRequest
     */
    numResults: number;
    /**
     *
     * @type {boolean}
     * @memberof RetrieveDocumentsRequest
     */
    rerank?: boolean;
    /**
     *
     * @type {Array<{ [key: string]: any | null; }>}
     * @memberof RetrieveDocumentsRequest
     */
    metadataFilters?: Array<{
        [key: string]: any | null;
    }>;
    /**
     *
     * @type {RetrieveContext}
     * @memberof RetrieveDocumentsRequest
     */
    context?: RetrieveContext;
    /**
     *
     * @type {AdvancedQuery}
     * @memberof RetrieveDocumentsRequest
     */
    advancedQuery?: AdvancedQuery;
}
/**
 * Check if a given object implements the RetrieveDocumentsRequest interface.
 */
export declare function instanceOfRetrieveDocumentsRequest(value: object): value is RetrieveDocumentsRequest;
export declare function RetrieveDocumentsRequestFromJSON(json: any): RetrieveDocumentsRequest;
export declare function RetrieveDocumentsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetrieveDocumentsRequest;
export declare function RetrieveDocumentsRequestToJSON(json: any): RetrieveDocumentsRequest;
export declare function RetrieveDocumentsRequestToJSONTyped(value?: RetrieveDocumentsRequest | null, ignoreDiscriminator?: boolean): any;