Merge pull request #43 from zeroentropy-ai/release-please--branches--main--changes--next--components--zeroentropy

release: 0.1.0-alpha.6

Author: npip99

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.5"
+  ".": "0.1.0-alpha.6"
 }

.stats.yml

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

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 0.1.0-alpha.6 (2025-07-08)
+
+Full Changelog: [v0.1.0-alpha.5...v0.1.0-alpha.6](https://github.com/zeroentropy-ai/zeroentropy-node/compare/v0.1.0-alpha.5...v0.1.0-alpha.6)
+
+### Features
+
+* **api:** manual updates ([77ce9ac](https://github.com/zeroentropy-ai/zeroentropy-node/commit/77ce9ac0be4962f4f1795498d44678942cde51ce))
+* **api:** manual updates ([9a6e616](https://github.com/zeroentropy-ai/zeroentropy-node/commit/9a6e616d7eb9d907d6e99a01f0db9b07003e3a6a))
+* **api:** manual updates ([628fbde](https://github.com/zeroentropy-ai/zeroentropy-node/commit/628fbde29b47202ba454c4078b071ff5f7c6c603))
+* **api:** manual updates ([9fdb2c0](https://github.com/zeroentropy-ai/zeroentropy-node/commit/9fdb2c0631e1afee0bdc0c4c70c908a9b11d7310))
+* **api:** manual updates ([15ace1c](https://github.com/zeroentropy-ai/zeroentropy-node/commit/15ace1c140e20e35f8ed9f173cbd295b79e2e165))
+
 ## 0.1.0-alpha.5 (2025-07-03)
 
 Full Changelog: [v0.1.0-alpha.4...v0.1.0-alpha.5](https://github.com/zeroentropy-ai/zeroentropy-node/compare/v0.1.0-alpha.4...v0.1.0-alpha.5)

api.md

@@ -1,13 +1,3 @@
-# Admin
-
-Types:
-
-- <code><a href="./src/resources/admin.ts">AdminCreateOrganizationResponse</a></code>
-
-Methods:
-
-- <code title="post /admin/create-organization">client.admin.<a href="./src/resources/admin.ts">createOrganization</a>({ ...params }) -> AdminCreateOrganizationResponse</code>
-
 # Status
 
 Types:
@@ -66,12 +56,12 @@ 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">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 /models/rerank">client.models.<a href="./src/resources/models.ts">rerank</a>({ ...params }) -> ModelRerankResponse</code>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "zeroentropy",
-  "version": "0.1.0-alpha.5",
+  "version": "0.1.0-alpha.6",
   "description": "The official TypeScript library for the ZeroEntropy API",
   "author": "ZeroEntropy <[email protected]>",
   "types": "dist/index.d.ts",

src/index.ts

@@ -7,7 +7,6 @@ import * as Pagination from './pagination';
 import { type GetDocumentInfoListCursorParams, GetDocumentInfoListCursorResponse } from './pagination';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
-import { Admin, AdminCreateOrganizationParams, AdminCreateOrganizationResponse } from './resources/admin';
 import {
   CollectionAddParams,
   CollectionAddResponse,
@@ -33,7 +32,7 @@ import {
   DocumentUpdateResponse,
   Documents,
 } from './resources/documents';
-import { ParserParseDocumentParams, ParserParseDocumentResponse, Parsers } from './resources/parsers';
+import { ModelRerankParams, ModelRerankResponse, Models } from './resources/models';
 import {
   Queries,
   QueryTopDocumentsParams,
@@ -161,12 +160,11 @@ export class ZeroEntropy extends Core.APIClient {
     this.apiKey = apiKey;
   }
 
-  admin: API.Admin = new API.Admin(this);
   status: API.Status = new API.Status(this);
   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.
@@ -211,14 +209,13 @@ export class ZeroEntropy extends Core.APIClient {
   static fileFromPath = Uploads.fileFromPath;
 }
 
-ZeroEntropy.Admin = Admin;
 ZeroEntropy.Status = Status;
 ZeroEntropy.Collections = Collections;
 ZeroEntropy.Documents = Documents;
 ZeroEntropy.DocumentGetInfoListResponsesGetDocumentInfoListCursor =
   DocumentGetInfoListResponsesGetDocumentInfoListCursor;
 ZeroEntropy.Queries = Queries;
-ZeroEntropy.Parsers = Parsers;
+ZeroEntropy.Models = Models;
 export declare namespace ZeroEntropy {
   export type RequestOptions = Core.RequestOptions;
 
@@ -228,12 +225,6 @@ export declare namespace ZeroEntropy {
     type GetDocumentInfoListCursorResponse as GetDocumentInfoListCursorResponse,
   };
 
-  export {
-    Admin as Admin,
-    type AdminCreateOrganizationResponse as AdminCreateOrganizationResponse,
-    type AdminCreateOrganizationParams as AdminCreateOrganizationParams,
-  };
-
   export {
     Status as Status,
     type StatusGetStatusResponse as StatusGetStatusResponse,
@@ -278,9 +269,9 @@ export declare namespace ZeroEntropy {
   };
 
   export {
-    Parsers as Parsers,
-    type ParserParseDocumentResponse as ParserParseDocumentResponse,
-    type ParserParseDocumentParams as ParserParseDocumentParams,
+    Models as Models,
+    type ModelRerankResponse as ModelRerankResponse,
+    type ModelRerankParams as ModelRerankParams,
   };
 }
 

src/resources/admin.ts

@@ -8,14 +8,15 @@ export class Documents extends APIResource {
   /**
    * Updates a document. This endpoint is atomic.
    *
-   * The only attribute currently supported for update is `metadata`. This endpoint
-   * can only be called with a non-null `metadata` if the document status is
-   * `indexed`.
+   * Currently both `metadata` and `index_status` are supported.
    *
-   * Sometimes, when updating a document, a new document ID will be assigned and the
-   * previous will be deleted. For this reason, the previous and the new document ID
-   * will both be returned in the response. If the document ID was not updated, then
-   * these two IDs will be identical.
+   * - When updating with a non-null `metadata`, the document must have
+   *   `index_status` of `indexed`. After this call, the document will have an
+   *   `index_status` of `not_indexed`, since the document will need to reindex with
+   *   the new metadata.
+   * - When updating with a non-null `index_status`, setting it to
+   *   `not_parsed or `not_indexed`requires that the document must have`index_status`of`parsing_failed`or`indexing_failed`,
+   *   respectively.
    *
    * A `404 Not Found` status code will be returned, if the provided collection name
    * or document path does not exist.
@@ -106,9 +107,10 @@ export class Documents extends APIResource {
 export class DocumentGetInfoListResponsesGetDocumentInfoListCursor extends GetDocumentInfoListCursor<DocumentGetInfoListResponse> {}
 
 export interface DocumentUpdateResponse {
-  new_id: string;
-
-  previous_id: string;
+  /**
+   * This string will always be "Success!". This may change in the future.
+   */
+  message?: string;
 }
 
 export interface DocumentDeleteResponse {
@@ -274,6 +276,14 @@ export interface DocumentUpdateParams {
    */
   path: string;
 
+  /**
+   * If the document is in the index_status of
+   * `parsing_failed or `indexing_failed`, then this endpoint allows you to update the index status to `not_parsed`and`not_indexed`,
+   * respectively. This allows the document to re-attempt to parse/index after
+   * failure.
+   */
+  index_status?: 'not_parsed' | 'not_indexed' | null;
+
   /**
    * If this field is provided, the given metadata json will replace the document's
    * existing metadata json. In other words, if you want to add a new field, you will

src/resources/documents.ts

@@ -1,6 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Admin, type AdminCreateOrganizationResponse, type AdminCreateOrganizationParams } from './admin';
 export {
   Collections,
   type CollectionDeleteResponse,
@@ -26,7 +25,7 @@ export {
   type DocumentGetInfoListParams,
   type DocumentGetPageInfoParams,
 } from './documents';
-export { Parsers, type ParserParseDocumentResponse, type ParserParseDocumentParams } from './parsers';
+export { Models, type ModelRerankResponse, type ModelRerankParams } from './models';
 export {
   Queries,
   type QueryTopDocumentsResponse,

src/resources/index.ts

@@ -0,0 +1,72 @@
+// 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 {
+  /**
+   * 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 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 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 ModelRerankResponse as ModelRerankResponse, type ModelRerankParams as ModelRerankParams };
+}