release: 0.1.0 (#7)

Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>

Author: stainless-app[bot]

.release-please-manifest.json

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

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 39
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-448bcb901d30570e0b3162114cc74ba9578f8179f00363c32a5a2b7f56b17841.yml
+configured_endpoints: 33
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/contextual-ai%2Fsunrise-4ed32c3243ce7a772e55bb1ba204736fc3fb1d712d8ca0eb91bac0c7ac626938.yml

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.1.0 (2025-01-15)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0](https://github.com/ContextualAI/contextual-client-node/compare/v0.1.0-alpha.2...v0.1.0)
+
+### Features
+
+* **api:** update via SDK Studio ([#6](https://github.com/ContextualAI/contextual-client-node/issues/6)) ([c4716b9](https://github.com/ContextualAI/contextual-client-node/commit/c4716b9941567e8194e7a423d3964bb10f9b0eb8))
+* **api:** update via SDK Studio ([#8](https://github.com/ContextualAI/contextual-client-node/issues/8)) ([b0ff25d](https://github.com/ContextualAI/contextual-client-node/commit/b0ff25db12010d4b6e2b8adf1dc08b2c03041499))
+* **api:** update via SDK Studio ([#9](https://github.com/ContextualAI/contextual-client-node/issues/9)) ([a2cb696](https://github.com/ContextualAI/contextual-client-node/commit/a2cb696735d01fe00508f2d6d5dfd40d30bebb9f))
+
 ## 0.1.0-alpha.2 (2025-01-14)
 
 Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/ContextualAI/contextual-client-node/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)

README.md

@@ -153,7 +153,7 @@ Alternatively, you can request a single page at a time:
 
 ```ts
 let page = await client.agents.list();
-for (const agent of page.data) {
+for (const agent of page.agents) {
   console.log(agent);
 }
 

api.md

@@ -98,21 +98,6 @@ Types:
 - <code><a href="./src/resources/agents/datasets/datasets.ts">DatasetMetadata</a></code>
 - <code><a href="./src/resources/agents/datasets/datasets.ts">ListDatasetsResponse</a></code>
 
-### Tune
-
-Types:
-
-- <code><a href="./src/resources/agents/datasets/tune.ts">TuneDeleteResponse</a></code>
-
-Methods:
-
-- <code title="post /agents/{agent_id}/datasets/tune">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">create</a>(agentId, { ...params }) -> CreateDatasetResponse</code>
-- <code title="get /agents/{agent_id}/datasets/tune/{dataset_name}">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">retrieve</a>(agentId, datasetName, { ...params }) -> Response</code>
-- <code title="put /agents/{agent_id}/datasets/tune/{dataset_name}">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">update</a>(agentId, datasetName, { ...params }) -> CreateDatasetResponse</code>
-- <code title="get /agents/{agent_id}/datasets/tune">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">list</a>(agentId, { ...params }) -> ListDatasetsResponse</code>
-- <code title="delete /agents/{agent_id}/datasets/tune/{dataset_name}">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">delete</a>(agentId, datasetName) -> unknown</code>
-- <code title="get /agents/{agent_id}/datasets/tune/{dataset_name}/metadata">client.agents.datasets.tune.<a href="./src/resources/agents/datasets/tune.ts">metadata</a>(agentId, datasetName, { ...params }) -> DatasetMetadata</code>
-
 ### Evaluate
 
 Types:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "contextual-client",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0",
   "description": "The official TypeScript library for the Contextual AI API",
   "author": "Contextual AI <support@contextual.ai>",
   "types": "dist/index.d.ts",

src/pagination.ts

@@ -117,7 +117,7 @@ export class DocumentsPage<Item> extends AbstractPage<Item> implements Documents
 }
 
 export interface PageResponse<Item> {
-  data: Array<Item>;
+  agents: Array<Item>;
 
   next_cursor: string;
 }
@@ -129,19 +129,19 @@ export interface PageParams {
 }
 
 export class Page<Item> extends AbstractPage<Item> implements PageResponse<Item> {
-  data: Array<Item>;
+  agents: Array<Item>;
 
   next_cursor: string;
 
   constructor(client: APIClient, response: Response, body: PageResponse<Item>, options: FinalRequestOptions) {
     super(client, response, body, options);
 
-    this.data = body.data || [];
+    this.agents = body.agents || [];
     this.next_cursor = body.next_cursor || '';
   }
 
   getPaginatedItems(): Item[] {
-    return this.data ?? [];
+    return this.agents ?? [];
   }
 
   // @deprecated Please use `nextPageInfo()` instead

src/resources/agents/agents.ts

@@ -32,8 +32,8 @@ export class Agents extends APIResource {
   /**
    * Create a new `Agent` with a specific configuration.
    *
-   * This creates a specialized RAG `Agent` which queries over a `Datastore` to
-   * retrieve relevant data on which its generations are grounded.
+   * This creates a specialized RAG `Agent` which queries over one or multiple
+   * `Datastores` to retrieve relevant data on which its generations are grounded.
    *
    * Retrieval and generation parameters are defined in the provided `Agent`
    * configuration.
@@ -128,10 +128,9 @@ export interface AgentMetadata {
   description?: string;
 
   /**
-   * Optional model ID of a tuned model to use for generation. Model must have been
-   * tuned on this agent; tuned models cannot be used across agents. Uses default
-   * model if none is specified. Set to `default` to deactivate the tuned model and
-   * use the default model.
+   * The model ID to use for generation. Tuned models can only be used for the agents
+   * on which they were tuned. If no model is specified, the default model is used.
+   * Set to `default` to switch from a tuned model to the default model.
    */
   llm_model_id?: string;
 
@@ -176,7 +175,7 @@ export interface ListAgentsResponse {
   /**
    * List of active agents
    */
-  data?: Array<Agent>;
+  agents?: Array<Agent>;
 
   /**
    * Next cursor to continue pagination. Omitted if there are no more agents to
@@ -228,10 +227,9 @@ export interface AgentUpdateParams {
   datastore_ids?: Array<string>;
 
   /**
-   * Optional model ID of a tuned model to use for generation. Model must have been
-   * tuned on this agent; tuned models cannot be used across agents. Uses default
-   * model if none is specified. Set to `default` to deactivate the tuned model and
-   * use the default model.
+   * The model ID to use for generation. Tuned models can only be used for the agents
+   * on which they were tuned. If no model is specified, the default model is used.
+   * Set to `default` to switch from a tuned model to the default model.
    */
   llm_model_id?: string;
 

src/resources/agents/datasets/datasets.ts

@@ -11,19 +11,8 @@ import {
   EvaluateRetrieveParams,
   EvaluateUpdateParams,
 } from './evaluate';
-import * as TuneAPI from './tune';
-import {
-  Tune,
-  TuneCreateParams,
-  TuneDeleteResponse,
-  TuneListParams,
-  TuneMetadataParams,
-  TuneRetrieveParams,
-  TuneUpdateParams,
-} from './tune';
 
 export class Datasets extends APIResource {
-  tune: TuneAPI.Tune = new TuneAPI.Tune(this._client);
   evaluate: EvaluateAPI.Evaluate = new EvaluateAPI.Evaluate(this._client);
 }
 
@@ -136,7 +125,6 @@ export namespace ListDatasetsResponse {
   }
 }
 
-Datasets.Tune = Tune;
 Datasets.Evaluate = Evaluate;
 
 export declare namespace Datasets {
@@ -146,16 +134,6 @@ export declare namespace Datasets {
     type ListDatasetsResponse as ListDatasetsResponse,
   };
 
-  export {
-    Tune as Tune,
-    type TuneDeleteResponse as TuneDeleteResponse,
-    type TuneCreateParams as TuneCreateParams,
-    type TuneRetrieveParams as TuneRetrieveParams,
-    type TuneUpdateParams as TuneUpdateParams,
-    type TuneListParams as TuneListParams,
-    type TuneMetadataParams as TuneMetadataParams,
-  };
-
   export {
     Evaluate as Evaluate,
     type EvaluateDeleteResponse as EvaluateDeleteResponse,

src/resources/agents/datasets/evaluate.ts

@@ -18,18 +18,11 @@ export class Evaluate extends APIResource {
    * defined for the `dataset_type`.
    *
    * File schema for `dataset_type` `evaluation_set` is a JSONL or CSV file where
-   * each line is one JSON object with the following keys:
+   * each line is one JSON object with the following required keys:
    *
    * - `prompt` (required, `string`): Prompt or question
    *
-   * - `response` (optional, `string`): Optional response to evaluate
-   *
    * - `reference` (required, `string`): Required reference or ground truth response
-   *
-   * - `guideline` (optional, `string`): Optional evaluation guidelines
-   *
-   * - `knowledge` (optional, `string`): Optional retrieved context for evaluation,
-   *   as a list of string text chunks
    */
   create(
     agentId: string,
@@ -49,9 +42,13 @@ export class Evaluate extends APIResource {
    * The `Dataset` content is downloaded in batches. Batch size can be configured to
    * meet specific processing requirements.
    *
-   * Returns a `StreamingResponse`, an asynchronous stream of `Dataset` content
-   * with: - Content-Type: application/octet-stream - Content-Disposition:
-   * attachment - Chunked transfer encoding
+   * Returns a `StreamingResponse`, an asynchronous stream of `Dataset` content with:
+   *
+   * - Content-Type: application/octet-stream
+   *
+   * - Content-Disposition: attachment
+   *
+   * - Chunked transfer encoding
    */
   retrieve(
     agentId: string,
@@ -84,18 +81,11 @@ export class Evaluate extends APIResource {
    * validating against its schema.
    *
    * File schema for `dataset_type` `evaluation_set` is a JSONL file where each line
-   * is one JSON object with the following keys:
-   *
-   * - `prompt` (required, `string`): Prompt or question
-   *
-   * - `response` (optional, `string`): Optional response to evaluate
-   *
-   * - `reference` (required, `string`): Required reference or ground truth response
+   * is one JSON object with the following required keys:
    *
-   * - `guideline` (optional, `string`): Optional evaluation guidelines
+   * - `prompt` (`string`): Prompt or question
    *
-   * - `knowledge` (optional, `string`): Optional retrieved context for evaluation,
-   *   as a list of string text chunks
+   * - `reference` (`string`): Required reference or ground truth response
    */
   update(
     agentId: string,