feat(api): manual updates

Author: stainless-app[bot]

.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
+configured_endpoints: 14
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zeroentropy%2Fzeroentropy-bd2f55f423e09b74f83cbad6034fb76f7052363308d02533a908b49543cff459.yml
+openapi_spec_hash: 6d7566ebda7fecac4069744949d547e0
 config_hash: beba80a17ba64c5439712e85129ab5ad

api.md

@@ -1,13 +1,5 @@
 # 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:

src/index.ts

@@ -7,7 +7,7 @@ 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 { Admin } from './resources/admin';
 import {
   CollectionAddParams,
   CollectionAddResponse,
@@ -228,11 +228,7 @@ export declare namespace ZeroEntropy {
     type GetDocumentInfoListCursorResponse as GetDocumentInfoListCursorResponse,
   };
 
-  export {
-    Admin as Admin,
-    type AdminCreateOrganizationResponse as AdminCreateOrganizationResponse,
-    type AdminCreateOrganizationParams as AdminCreateOrganizationParams,
-  };
+  export { Admin as Admin };
 
   export {
     Status as Status,

src/resources/admin.ts

@@ -1,46 +1,5 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../resource';
-import * as Core from '../core';
 
-export class Admin extends APIResource {
-  /**
-   * Creates or updates an organization with the provided organization name. An API
-   * Key will be returned.
-   *
-   * Returns 201 if a new organization was created, 200 if an existing organization
-   * was found.
-   */
-  createOrganization(
-    body: AdminCreateOrganizationParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<AdminCreateOrganizationResponse> {
-    return this._client.post('/admin/create-organization', { body, ...options });
-  }
-}
-
-export interface AdminCreateOrganizationResponse {
-  /**
-   * The API Key for this organization.
-   */
-  api_key: string;
-
-  /**
-   * The name of the organization
-   */
-  organization_name: string;
-}
-
-export interface AdminCreateOrganizationParams {
-  /**
-   * The orgniazation name to create. Must be unique.
-   */
-  organization_name: string;
-}
-
-export declare namespace Admin {
-  export {
-    type AdminCreateOrganizationResponse as AdminCreateOrganizationResponse,
-    type AdminCreateOrganizationParams as AdminCreateOrganizationParams,
-  };
-}
+export class Admin extends APIResource {}

src/resources/documents.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/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Admin, type AdminCreateOrganizationResponse, type AdminCreateOrganizationParams } from './admin';
+export { Admin } from './admin';
 export {
   Collections,
   type CollectionDeleteResponse,

src/resources/queries.ts

@@ -168,9 +168,9 @@ export namespace QueryTopSnippetsResponse {
    */
   export interface Result {
     /**
-     * If requested, this contains the full string content of this snippet.
+     * The full string content of this snippet.
      */
-    content: string | null;
+    content: string;
 
     /**
      * The end index of this snippet.
@@ -214,8 +214,7 @@ export interface QueryTopDocumentsParams {
   k: number;
 
   /**
-   * The natural language query to search with. This cannot exceed 4096 characters (A
-   * single UTF-8 codepoint, is considered to be 1 character).
+   * The natural language query to search with. This cannot exceed 4096 UTF-8 bytes.
    */
   query: string;
 
@@ -239,6 +238,13 @@ export interface QueryTopDocumentsParams {
    * result quality.
    */
   latency_mode?: 'low' | 'high';
+
+  /**
+   * The reranker to use after initial retrieval. The default is `null`. You can find
+   * available model ids along with more information at
+   * [/models/rerank](/api-reference/models/rerank).
+   */
+  reranker?: string | null;
 }
 
 export interface QueryTopPagesParams {
@@ -249,14 +255,13 @@ export interface QueryTopPagesParams {
 
   /**
    * The number of pages to return. If there are not enough pages matching your
-   * filters, then fewer may be returned. This number must be between 1 and 2048,
+   * filters, then fewer may be returned. This number must be between 1 and 1024,
    * inclusive.
    */
   k: number;
 
   /**
-   * The natural language query to search with. This cannot exceed 4096 characters (A
-   * single UTF-8 codepoint, is considered to be 1 character).
+   * The natural language query to search with. This cannot exceed 4096 UTF-8 bytes.
    */
   query: string;
 
@@ -289,7 +294,7 @@ export interface QueryTopSnippetsParams {
 
   /**
    * The number of snippets to return. If there are not enough snippets matching your
-   * filters, then fewer may be returned. This number must be between 1 and 2048,
+   * filters, then fewer may be returned. This number must be between 1 and 128,
    * inclusive.
    */
   k: number;
@@ -313,22 +318,20 @@ export interface QueryTopSnippetsParams {
    */
   include_document_metadata?: boolean;
 
-  /**
-   * Note that for Top K Snippets, only latency_mode "low" is available. This option
-   * selects between our latency modes. The higher latency mode takes longer, but can
-   * allow for more accurate responses. If desired, test both to customize your
-   * search experience for your particular use-case, or use the default of "low" and
-   * only swap if you need an additional improvement in search result quality.
-   */
-  latency_mode?: 'low';
-
   /**
    * Enable precise responses. Precise responses will have higher latency, but
    * provide much more precise snippets. When `precise_responses` is set to `true`,
    * the responses will average 200 characters. If set to `false`, the responses will
    * average 2000 characters. The default is `false`.
    */
   precise_responses?: boolean;
+
+  /**
+   * The reranker to use after initial retrieval. The default is `null`. You can find
+   * available model ids, along with more information, at
+   * [/models/rerank](/api-reference/models/rerank).
+   */
+  reranker?: string | null;
 }
 
 export declare namespace Queries {

tests/api-resources/admin.test.ts

@@ -24,6 +24,7 @@ describe('resource documents', () => {
     const response = await client.documents.update({
       collection_name: 'collection_name',
       path: 'path',
+      index_status: 'not_parsed',
       metadata: { foo: 'string' },
     });
   });

tests/api-resources/documents.test.ts

@@ -32,6 +32,7 @@ describe('resource queries', () => {
       filter: { foo: 'bar' },
       include_metadata: true,
       latency_mode: 'low',
+      reranker: 'reranker',
     });
   });
 
@@ -83,8 +84,8 @@ describe('resource queries', () => {
       query: 'query',
       filter: { foo: 'bar' },
       include_document_metadata: true,
-      latency_mode: 'low',
       precise_responses: true,
+      reranker: 'reranker',
     });
   });
 });