@pinecone-database/pinecone
Version:
This is the official Node.js SDK for [Pinecone](https://www.pinecone.io), written in TypeScript.
90 lines (89 loc) • 2.62 kB
TypeScript
/**
* Pinecone Assistant Data Plane API
* Pinecone Assistant Engine is a context engine to store and retrieve relevant knowledge from millions of documents at scale. This API supports interactions with assistants.
*
* The version of the OpenAPI document: 2025-04
* Contact: support@pinecone.io
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
* AssistantFileModel is the response format to a successful file upload request.
* @export
* @interface AssistantFileModel
*/
export interface AssistantFileModel {
/**
*
* @type {string}
* @memberof AssistantFileModel
*/
name: string;
/**
*
* @type {string}
* @memberof AssistantFileModel
*/
id: string;
/**
*
* @type {object}
* @memberof AssistantFileModel
*/
metadata?: object | null;
/**
*
* @type {Date}
* @memberof AssistantFileModel
*/
createdOn?: Date;
/**
*
* @type {Date}
* @memberof AssistantFileModel
*/
updatedOn?: Date;
/**
*
* @type {string}
* @memberof AssistantFileModel
*/
status?: AssistantFileModelStatusEnum;
/**
* The percentage of the file that has been processed
* @type {number}
* @memberof AssistantFileModel
*/
percentDone?: number | null;
/**
* A signed url that gives you access to the underlying file
* @type {string}
* @memberof AssistantFileModel
*/
signedUrl?: string | null;
/**
* A message describing any error during file processing, provided only if an error occurs.
* @type {string}
* @memberof AssistantFileModel
*/
errorMessage?: string | null;
}
/**
* @export
*/
export declare const AssistantFileModelStatusEnum: {
readonly Processing: "Processing";
readonly Available: "Available";
readonly Deleting: "Deleting";
readonly ProcessingFailed: "ProcessingFailed";
};
export type AssistantFileModelStatusEnum = typeof AssistantFileModelStatusEnum[keyof typeof AssistantFileModelStatusEnum];
/**
* Check if a given object implements the AssistantFileModel interface.
*/
export declare function instanceOfAssistantFileModel(value: object): boolean;
export declare function AssistantFileModelFromJSON(json: any): AssistantFileModel;
export declare function AssistantFileModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssistantFileModel;
export declare function AssistantFileModelToJSON(value?: AssistantFileModel | null): any;