feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 14
+configured_endpoints: 15
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zeroentropy%2Fzeroentropy-bd2f55f423e09b74f83cbad6034fb76f7052363308d02533a908b49543cff459.yml
 openapi_spec_hash: 6d7566ebda7fecac4069744949d547e0
-config_hash: 4e1eddd5022c75526a18c05e8a04e2c8
+config_hash: bad49a5f0d0d03ed67d97a3adc3e00d6

api.md

@@ -56,12 +56,14 @@ Methods:
 - <code title="post /queries/top-pages">client.queries.<a href="./src/resources/queries.ts">topPages</a>({ ...params }) -> QueryTopPagesResponse</code>
 - <code title="post /queries/top-snippets">client.queries.<a href="./src/resources/queries.ts">topSnippets</a>({ ...params }) -> QueryTopSnippetsResponse</code>
 
-# Parsers
+# Models
 
 Types:
 
-- <code><a href="./src/resources/parsers.ts">ParserParseDocumentResponse</a></code>
+- <code><a href="./src/resources/models.ts">ModelParseDocumentResponse</a></code>
+- <code><a href="./src/resources/models.ts">ModelRerankResponse</a></code>
 
 Methods:
 
-- <code title="post /parsers/parse-document">client.parsers.<a href="./src/resources/parsers.ts">parseDocument</a>({ ...params }) -> ParserParseDocumentResponse</code>
+- <code title="post /parsers/parse-document">client.models.<a href="./src/resources/models.ts">parseDocument</a>({ ...params }) -> ModelParseDocumentResponse</code>
+- <code title="post /models/rerank">client.models.<a href="./src/resources/models.ts">rerank</a>({ ...params }) -> ModelRerankResponse</code>

src/index.ts

@@ -32,7 +32,13 @@ import {
   DocumentUpdateResponse,
   Documents,
 } from './resources/documents';
-import { ParserParseDocumentParams, ParserParseDocumentResponse, Parsers } from './resources/parsers';
+import {
+  ModelParseDocumentParams,
+  ModelParseDocumentResponse,
+  ModelRerankParams,
+  ModelRerankResponse,
+  Models,
+} from './resources/models';
 import {
   Queries,
   QueryTopDocumentsParams,
@@ -164,7 +170,7 @@ export class ZeroEntropy extends Core.APIClient {
   collections: API.Collections = new API.Collections(this);
   documents: API.Documents = new API.Documents(this);
   queries: API.Queries = new API.Queries(this);
-  parsers: API.Parsers = new API.Parsers(this);
+  models: API.Models = new API.Models(this);
 
   /**
    * Check whether the base URL is set to its default.
@@ -215,7 +221,7 @@ ZeroEntropy.Documents = Documents;
 ZeroEntropy.DocumentGetInfoListResponsesGetDocumentInfoListCursor =
   DocumentGetInfoListResponsesGetDocumentInfoListCursor;
 ZeroEntropy.Queries = Queries;
-ZeroEntropy.Parsers = Parsers;
+ZeroEntropy.Models = Models;
 export declare namespace ZeroEntropy {
   export type RequestOptions = Core.RequestOptions;
 
@@ -269,9 +275,11 @@ export declare namespace ZeroEntropy {
   };
 
   export {
-    Parsers as Parsers,
-    type ParserParseDocumentResponse as ParserParseDocumentResponse,
-    type ParserParseDocumentParams as ParserParseDocumentParams,
+    Models as Models,
+    type ModelParseDocumentResponse as ModelParseDocumentResponse,
+    type ModelRerankResponse as ModelRerankResponse,
+    type ModelParseDocumentParams as ModelParseDocumentParams,
+    type ModelRerankParams as ModelRerankParams,
   };
 }
 

src/resources/index.ts

@@ -25,7 +25,13 @@ export {
   type DocumentGetInfoListParams,
   type DocumentGetPageInfoParams,
 } from './documents';
-export { Parsers, type ParserParseDocumentResponse, type ParserParseDocumentParams } from './parsers';
+export {
+  Models,
+  type ModelParseDocumentResponse,
+  type ModelRerankResponse,
+  type ModelParseDocumentParams,
+  type ModelRerankParams,
+} from './models';
 export {
   Queries,
   type QueryTopDocumentsResponse,

src/resources/models.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class Models extends APIResource {
+  /**
+   * This provides access to the parsers that we use for indexing. This endpoint will
+   * not access any collection or search index, and the result will not be saved.
+   * This will use the same parsing method as the `/documents/add-document` endpoint.
+   *
+   * A common use-case for this endpoint, is to use our parser in combination with
+   * your own pre-processing step, before then uploading it to the search index using
+   * the `text-pages` filetype.
+   */
+  parseDocument(
+    body: ModelParseDocumentParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ModelParseDocumentResponse> {
+    return this._client.post('/parsers/parse-document', { body, ...options });
+  }
+
+  /**
+   * Reranks the provided documents, according to the provided query.
+   *
+   * The results will be sorted by descending order of relevance. For each document,
+   * the index and the score will be returned. The index is relative to the documents
+   * array that was passed in. The score is the query-document relevancy determined
+   * by the reranker model. The value will be returned in descending order to
+   * relevance.
+   */
+  rerank(body: ModelRerankParams, options?: Core.RequestOptions): Core.APIPromise<ModelRerankResponse> {
+    return this._client.post('/models/rerank', { body, ...options });
+  }
+}
+
+export interface ModelParseDocumentResponse {
+  /**
+   * The parsed pages. Each string will contain the full contents of a page.
+   */
+  pages: Array<string>;
+}
+
+export interface ModelRerankResponse {
+  /**
+   * The results, ordered by descending order of relevance to the query.
+   */
+  results: Array<ModelRerankResponse.Result>;
+}
+
+export namespace ModelRerankResponse {
+  export interface Result {
+    /**
+     * The index of this document, relative to the original document array passed into
+     * the request.
+     */
+    index: number;
+
+    /**
+     * The relevance score between this document and the query. This number will range
+     * between 0.0 and 1.0. This score is dependent on only the query and the scored
+     * document; other documents do not affect this score. This value is deterministic,
+     * but may vary slightly due to floating point error.
+     */
+    relevance_score: number;
+  }
+}
+
+export interface ModelParseDocumentParams {
+  /**
+   * The document's raw data, as a base64-encoded string
+   */
+  base64_data: string;
+}
+
+export interface ModelRerankParams {
+  /**
+   * The list of documents to rerank. Each document is a string.
+   */
+  documents: Array<string>;
+
+  /**
+   * The query to rerank the documents by. Results will be in descending order of
+   * relevance.
+   */
+  query: string;
+
+  /**
+   * The model ID to use for reranking. Options are: ["zerank-1-large"]
+   */
+  model?: string;
+
+  /**
+   * If provided, then only the top `n` documents will be returned in the results
+   * array.
+   */
+  top_n?: number | null;
+}
+
+export declare namespace Models {
+  export {
+    type ModelParseDocumentResponse as ModelParseDocumentResponse,
+    type ModelRerankResponse as ModelRerankResponse,
+    type ModelParseDocumentParams as ModelParseDocumentParams,
+    type ModelRerankParams as ModelRerankParams,
+  };
+}

src/resources/parsers.ts

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import ZeroEntropy from 'zeroentropy';
+import { Response } from 'node-fetch';
+
+const client = new ZeroEntropy({
+  apiKey: 'My API Key',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource models', () => {
+  test('parseDocument: only required params', async () => {
+    const responsePromise = client.models.parseDocument({ base64_data: 'base64_data' });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('parseDocument: required and optional params', async () => {
+    const response = await client.models.parseDocument({ base64_data: 'base64_data' });
+  });
+
+  test('rerank: only required params', async () => {
+    const responsePromise = client.models.rerank({ documents: ['string'], query: 'query' });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('rerank: required and optional params', async () => {
+    const response = await client.models.rerank({
+      documents: ['string'],
+      query: 'query',
+      model: 'model',
+      top_n: 0,
+    });
+  });
+});