/* tslint:disable */ /* eslint-disable */ /** * Fabric API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { AskMemories200Response, Memory, MemoryJob, MemoryJobSource, SearchMemories200Response, SearchMemoriesOrderParameter, UpdateMemoryRequest, } from '../models/index'; import { AskMemories200ResponseFromJSON, AskMemories200ResponseToJSON, MemoryFromJSON, MemoryToJSON, MemoryJobFromJSON, MemoryJobToJSON, MemoryJobSourceFromJSON, MemoryJobSourceToJSON, SearchMemories200ResponseFromJSON, SearchMemories200ResponseToJSON, SearchMemoriesOrderParameterFromJSON, SearchMemoriesOrderParameterToJSON, UpdateMemoryRequestFromJSON, UpdateMemoryRequestToJSON, } from '../models/index'; export type AskMemoriesRequest = Omit<{ query: string; baseId?: string; }, 'baseId'>; export type CreateMemoryRequest = Omit; export type DeleteMemoryRequest = Omit<{ memoryId: string; baseId?: string; }, 'baseId'>; export type GetMemoryRequest = Omit<{ memoryId: string; baseId?: string; }, 'baseId'>; export type GetMemoryJobRequest = Omit<{ jobId: string; baseId?: string; }, 'baseId'>; export type SearchMemoriesRequest = Omit<{ baseId?: string; query?: string; precision?: number | null; expandQueries?: number | null; rerankCandidates?: number | null; rerankThreshold?: number | null; limit?: number; offset?: number | null; order?: SearchMemoriesOrderParameter; }, 'baseId'>; export type UpdateMemoryOperationRequest = Omit; /** * */ export class MemoriesApi extends runtime.BaseAPI { /** * Answer a query in natural language using relevant memories as context. * Ask memories */ async askRaw(requestParameters: AskMemoriesRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['query'] == null) { throw new runtime.RequiredError( 'query', 'Required parameter "query" was null or undefined when calling ().' ); } const queryParameters: any = {}; if (requestParameters['query'] != null) { queryParameters['query'] = requestParameters['query']; } const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories/ask`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => AskMemories200ResponseFromJSON(jsonValue)); } /** * Answer a query in natural language using relevant memories as context. * Ask memories */ async ask(requestParameters: AskMemoriesRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.askRaw(requestParameters, initOverrides); return await response.value(); } /** * Create a memory by analyzing the provided input data. Set `infer` to `false` to skip inference and store the memory verbatim. Memory inference is asynchronous. The response contains a job ID which can be used to track the status of the memory creation. * Create memory */ async createRaw(requestParameters: CreateMemoryRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, body: MemoryJobSourceToJSON(requestParameters), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => MemoryJobFromJSON(jsonValue)); } /** * Create a memory by analyzing the provided input data. Set `infer` to `false` to skip inference and store the memory verbatim. Memory inference is asynchronous. The response contains a job ID which can be used to track the status of the memory creation. * Create memory */ async create(requestParameters: CreateMemoryRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.createRaw(requestParameters, initOverrides); return await response.value(); } /** * Delete an existing memory. * Delete memory */ async deleteRaw(requestParameters: DeleteMemoryRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['memoryId'] == null) { throw new runtime.RequiredError( 'memoryId', 'Required parameter "memoryId" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories/{memoryId}`; urlPath = urlPath.replace(`{${"memoryId"}}`, encodeURIComponent(String(requestParameters['memoryId']))); const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Delete an existing memory. * Delete memory */ async delete(requestParameters: DeleteMemoryRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { await this.deleteRaw(requestParameters, initOverrides); } /** * Retrieve the details of a specific memory. * Get memory */ async getRaw(requestParameters: GetMemoryRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['memoryId'] == null) { throw new runtime.RequiredError( 'memoryId', 'Required parameter "memoryId" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories/{memoryId}`; urlPath = urlPath.replace(`{${"memoryId"}}`, encodeURIComponent(String(requestParameters['memoryId']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => MemoryFromJSON(jsonValue)); } /** * Retrieve the details of a specific memory. * Get memory */ async get(requestParameters: GetMemoryRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.getRaw(requestParameters, initOverrides); return await response.value(); } /** * Retrieve the status and details of a memory creation job. * Get memory job */ async getJobRaw(requestParameters: GetMemoryJobRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['jobId'] == null) { throw new runtime.RequiredError( 'jobId', 'Required parameter "jobId" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories/jobs/{jobId}`; urlPath = urlPath.replace(`{${"jobId"}}`, encodeURIComponent(String(requestParameters['jobId']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => MemoryJobFromJSON(jsonValue)); } /** * Retrieve the status and details of a memory creation job. * Get memory job */ async getJob(requestParameters: GetMemoryJobRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.getJobRaw(requestParameters, initOverrides); return await response.value(); } /** * Search through memories using a query string. Uses hybrid semantic and keyword-based search with a recency bias to find relevant memories. Results are sorted by relevance and include a relevance score (higher is better). * Search memories */ async searchRaw(requestParameters: SearchMemoriesRequest = {}, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; if (requestParameters['query'] != null) { queryParameters['query'] = requestParameters['query']; } if (requestParameters['precision'] != null) { queryParameters['precision'] = requestParameters['precision']; } if (requestParameters['expandQueries'] != null) { queryParameters['expandQueries'] = requestParameters['expandQueries']; } if (requestParameters['rerankCandidates'] != null) { queryParameters['rerankCandidates'] = requestParameters['rerankCandidates']; } if (requestParameters['rerankThreshold'] != null) { queryParameters['rerankThreshold'] = requestParameters['rerankThreshold']; } if (requestParameters['limit'] != null) { queryParameters['limit'] = requestParameters['limit']; } if (requestParameters['offset'] != null) { queryParameters['offset'] = requestParameters['offset']; } if (requestParameters['order'] != null) { queryParameters['order'] = requestParameters['order']; } const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories/search`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SearchMemories200ResponseFromJSON(jsonValue)); } /** * Search through memories using a query string. Uses hybrid semantic and keyword-based search with a recency bias to find relevant memories. Results are sorted by relevance and include a relevance score (higher is better). * Search memories */ async search(requestParameters: SearchMemoriesRequest = {}, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.searchRaw(requestParameters, initOverrides); return await response.value(); } /** * Update the name and content of an existing memory. * Update memory */ async updateRaw(requestParameters: UpdateMemoryOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['memoryId'] == null) { throw new runtime.RequiredError( 'memoryId', 'Required parameter "memoryId" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/memories/{memoryId}`; urlPath = urlPath.replace(`{${"memoryId"}}`, encodeURIComponent(String(requestParameters['memoryId']))); const response = await this.request({ path: urlPath, method: 'PATCH', headers: headerParameters, query: queryParameters, body: UpdateMemoryRequestToJSON(requestParameters), }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Update the name and content of an existing memory. * Update memory */ async update(requestParameters: UpdateMemoryOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { await this.updateRaw(requestParameters, initOverrides); } }