@emergentmethods/asknews-typescript-sdk/src/models/CreateChatCompletionRequest.ts

Typescript SDK for AskNews API

/* tslint:disable */
/* eslint-disable */
/**
 * AskNews API
 * AskNews API [![status](https://status.asknews.app/api/badge/2/status?style=for-the-badge)](https://status.asknews.app/status/prod)
 *
 * The version of the OpenAPI document: 0.24.22
 * Contact: contact@emergentmethods.ai
 *
 * 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 { User } from './User';
import {
    UserFromJSON,
    UserFromJSONTyped,
    UserToJSON,
    UserToJSONTyped,
} from './User';
import type { FilterParams } from './FilterParams';
import {
    FilterParamsFromJSON,
    FilterParamsFromJSONTyped,
    FilterParamsToJSON,
    FilterParamsToJSONTyped,
} from './FilterParams';
import type { Stop } from './Stop';
import {
    StopFromJSON,
    StopFromJSONTyped,
    StopToJSON,
    StopToJSONTyped,
} from './Stop';
import type { ThreadId } from './ThreadId';
import {
    ThreadIdFromJSON,
    ThreadIdFromJSONTyped,
    ThreadIdToJSON,
    ThreadIdToJSONTyped,
} from './ThreadId';
import type { CreateChatCompletionRequestMessage } from './CreateChatCompletionRequestMessage';
import {
    CreateChatCompletionRequestMessageFromJSON,
    CreateChatCompletionRequestMessageFromJSONTyped,
    CreateChatCompletionRequestMessageToJSON,
    CreateChatCompletionRequestMessageToJSONTyped,
} from './CreateChatCompletionRequestMessage';

/**
 * 
 * @export
 * @interface CreateChatCompletionRequest
 */
export interface CreateChatCompletionRequest {
    [key: string]: any | any;
    /**
     * 
     * @type {string}
     * @memberof CreateChatCompletionRequest
     */
    model?: string;
    /**
     * 
     * @type {Array<CreateChatCompletionRequestMessage>}
     * @memberof CreateChatCompletionRequest
     */
    messages: Array<CreateChatCompletionRequestMessage>;
    /**
     * 
     * @type {number}
     * @memberof CreateChatCompletionRequest
     */
    temperature?: number;
    /**
     * 
     * @type {number}
     * @memberof CreateChatCompletionRequest
     */
    topP?: number;
    /**
     * 
     * @type {number}
     * @memberof CreateChatCompletionRequest
     */
    n?: number;
    /**
     * 
     * @type {boolean}
     * @memberof CreateChatCompletionRequest
     */
    stream?: boolean;
    /**
     * 
     * @type {Stop}
     * @memberof CreateChatCompletionRequest
     */
    stop?: Stop;
    /**
     * 
     * @type {number}
     * @memberof CreateChatCompletionRequest
     */
    maxTokens?: number;
    /**
     * 
     * @type {number}
     * @memberof CreateChatCompletionRequest
     */
    presencePenalty?: number;
    /**
     * 
     * @type {number}
     * @memberof CreateChatCompletionRequest
     */
    frequencyPenalty?: number;
    /**
     * 
     * @type {ThreadId}
     * @memberof CreateChatCompletionRequest
     */
    threadId?: ThreadId;
    /**
     * 
     * @type {User}
     * @memberof CreateChatCompletionRequest
     */
    user?: User;
    /**
     * 
     * @type {string}
     * @memberof CreateChatCompletionRequest
     */
    inlineCitations?: CreateChatCompletionRequestInlineCitationsEnum;
    /**
     * 
     * @type {boolean}
     * @memberof CreateChatCompletionRequest
     */
    appendReferences?: boolean;
    /**
     * 
     * @type {boolean}
     * @memberof CreateChatCompletionRequest
     */
    journalistMode?: boolean;
    /**
     * 
     * @type {boolean}
     * @memberof CreateChatCompletionRequest
     */
    asknewsWatermark?: boolean;
    /**
     * 
     * @type {boolean}
     * @memberof CreateChatCompletionRequest
     */
    conversationalAwareness?: boolean;
    /**
     * 
     * @type {FilterParams}
     * @memberof CreateChatCompletionRequest
     */
    filterParams?: FilterParams;
}


/**
 * @export
 */
export const CreateChatCompletionRequestInlineCitationsEnum = {
    Numbered: 'numbered',
    MarkdownLink: 'markdown_link',
    None: 'none'
} as const;
export type CreateChatCompletionRequestInlineCitationsEnum = typeof CreateChatCompletionRequestInlineCitationsEnum[keyof typeof CreateChatCompletionRequestInlineCitationsEnum];


/**
 * Check if a given object implements the CreateChatCompletionRequest interface.
 */
export function instanceOfCreateChatCompletionRequest(value: object): value is CreateChatCompletionRequest {
    if (!('messages' in value) || value['messages'] === undefined) return false;
    return true;
}

export function CreateChatCompletionRequestFromJSON(json: any): CreateChatCompletionRequest {
    return CreateChatCompletionRequestFromJSONTyped(json, false);
}

export function CreateChatCompletionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateChatCompletionRequest {
    if (json == null) {
        return json;
    }
    return {
        
            ...json,
        'model': json['model'] == null ? undefined : json['model'],
        'messages': ((json['messages'] as Array<any>).map(CreateChatCompletionRequestMessageFromJSON)),
        'temperature': json['temperature'] == null ? undefined : json['temperature'],
        'topP': json['top_p'] == null ? undefined : json['top_p'],
        'n': json['n'] == null ? undefined : json['n'],
        'stream': json['stream'] == null ? undefined : json['stream'],
        'stop': json['stop'] == null ? undefined : StopFromJSON(json['stop']),
        'maxTokens': json['max_tokens'] == null ? undefined : json['max_tokens'],
        'presencePenalty': json['presence_penalty'] == null ? undefined : json['presence_penalty'],
        'frequencyPenalty': json['frequency_penalty'] == null ? undefined : json['frequency_penalty'],
        'threadId': json['thread_id'] == null ? undefined : ThreadIdFromJSON(json['thread_id']),
        'user': json['user'] == null ? undefined : UserFromJSON(json['user']),
        'inlineCitations': json['inline_citations'] == null ? undefined : json['inline_citations'],
        'appendReferences': json['append_references'] == null ? undefined : json['append_references'],
        'journalistMode': json['journalist_mode'] == null ? undefined : json['journalist_mode'],
        'asknewsWatermark': json['asknews_watermark'] == null ? undefined : json['asknews_watermark'],
        'conversationalAwareness': json['conversational_awareness'] == null ? undefined : json['conversational_awareness'],
        'filterParams': json['filter_params'] == null ? undefined : FilterParamsFromJSON(json['filter_params']),
    };
}

export function CreateChatCompletionRequestToJSON(json: any): CreateChatCompletionRequest {
    return CreateChatCompletionRequestToJSONTyped(json, false);
}

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

    return {
        
            ...value,
        'model': value['model'],
        'messages': ((value['messages'] as Array<any>).map(CreateChatCompletionRequestMessageToJSON)),
        'temperature': value['temperature'],
        'top_p': value['topP'],
        'n': value['n'],
        'stream': value['stream'],
        'stop': StopToJSON(value['stop']),
        'max_tokens': value['maxTokens'],
        'presence_penalty': value['presencePenalty'],
        'frequency_penalty': value['frequencyPenalty'],
        'thread_id': ThreadIdToJSON(value['threadId']),
        'user': UserToJSON(value['user']),
        'inline_citations': value['inlineCitations'],
        'append_references': value['appendReferences'],
        'journalist_mode': value['journalistMode'],
        'asknews_watermark': value['asknewsWatermark'],
        'conversational_awareness': value['conversationalAwareness'],
        'filter_params': FilterParamsToJSON(value['filterParams']),
    };
}