@vectorize-io/vectorize-client/src/models/RetrieveDocumentsResponse.ts

Client for the Vectorize API

/* tslint:disable */
/* eslint-disable */
/**
 * 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 { mapValues } from '../runtime';
import type { Document } from './Document';
import {
    DocumentFromJSON,
    DocumentFromJSONTyped,
    DocumentToJSON,
    DocumentToJSONTyped,
} from './Document';

/**
 * 
 * @export
 * @interface RetrieveDocumentsResponse
 */
export interface RetrieveDocumentsResponse {
    /**
     * 
     * @type {string}
     * @memberof RetrieveDocumentsResponse
     */
    question: string;
    /**
     * 
     * @type {Array<Document>}
     * @memberof RetrieveDocumentsResponse
     */
    documents: Array<Document>;
    /**
     * 
     * @type {number}
     * @memberof RetrieveDocumentsResponse
     */
    averageRelevancy: number;
    /**
     * 
     * @type {number}
     * @memberof RetrieveDocumentsResponse
     */
    ndcg: number;
}

/**
 * Check if a given object implements the RetrieveDocumentsResponse interface.
 */
export function instanceOfRetrieveDocumentsResponse(value: object): value is RetrieveDocumentsResponse {
    if (!('question' in value) || value['question'] === undefined) return false;
    if (!('documents' in value) || value['documents'] === undefined) return false;
    if (!('averageRelevancy' in value) || value['averageRelevancy'] === undefined) return false;
    if (!('ndcg' in value) || value['ndcg'] === undefined) return false;
    return true;
}

export function RetrieveDocumentsResponseFromJSON(json: any): RetrieveDocumentsResponse {
    return RetrieveDocumentsResponseFromJSONTyped(json, false);
}

export function RetrieveDocumentsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): RetrieveDocumentsResponse {
    if (json == null) {
        return json;
    }
    return {
        
        'question': json['question'],
        'documents': ((json['documents'] as Array<any>).map(DocumentFromJSON)),
        'averageRelevancy': json['average_relevancy'],
        'ndcg': json['ndcg'],
    };
}

export function RetrieveDocumentsResponseToJSON(json: any): RetrieveDocumentsResponse {
    return RetrieveDocumentsResponseToJSONTyped(json, false);
}

export function RetrieveDocumentsResponseToJSONTyped(value?: RetrieveDocumentsResponse | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'question': value['question'],
        'documents': ((value['documents'] as Array<any>).map(DocumentToJSON)),
        'average_relevancy': value['averageRelevancy'],
        'ndcg': value['ndcg'],
    };
}