syllable-sdk 0.1.0-alpha.65 → 0.1.0-alpha.67

package/src/models/components/listresponsecustommessageresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./custommessageresponse.js";
 
 export type ListResponseCustomMessageResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<CustomMessageResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsedashboardresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./dashboardresponse.js";
 
 export type ListResponseDashboardResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<DashboardResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsedatasourcemetadataresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./datasourcemetadataresponse.js";
 
 export type ListResponseDataSourceMetadataResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<DataSourceMetadataResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponseevent.ts

@@ -15,10 +15,25 @@ import {
 } from "./event.js";
 
 export type ListResponseEvent = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<Event>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponseinsighttooloutput.ts

@@ -15,10 +15,25 @@ import {
 } from "./insighttooloutput.js";
 
 export type ListResponseInsightToolOutput = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<InsightToolOutput>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponseinsightworkflowoutput.ts

@@ -15,10 +15,25 @@ import {
 } from "./insightworkflowoutput.js";
 
 export type ListResponseInsightWorkflowOutput = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<InsightWorkflowOutput>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponselanguagegroupresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./languagegroupresponse.js";
 
 export type ListResponseLanguageGroupResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<LanguageGroupResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsepromptresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./promptresponse.js";
 
 export type ListResponsePromptResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<PromptResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponseserviceresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./serviceresponse.js";
 
 export type ListResponseServiceResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<ServiceResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsesession.ts

@@ -15,10 +15,25 @@ import {
 } from "./session.js";
 
 export type ListResponseSession = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<Session>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsesessionlabel.ts

@@ -15,10 +15,25 @@ import {
 } from "./sessionlabel.js";
 
 export type ListResponseSessionLabel = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<SessionLabel>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/listresponsetoolresponse.ts

@@ -15,10 +15,25 @@ import {
 } from "./toolresponse.js";
 
 export type ListResponseToolResponse = {
+  /**
+   * List of items returned from the query
+   */
   items: Array<ToolResponse>;
+  /**
+   * The page number of the results (0-based)
+   */
   page: number;
+  /**
+   * The number of items returned per page
+   */
   pageSize: number;
+  /**
+   * The total number of pages of results given the indicated page size
+   */
   totalPages?: number | null | undefined;
+  /**
+   * The total number of items returned from the query
+   */
   totalCount?: number | null | undefined;
 };
 

package/src/models/components/orderbydirection.ts

@@ -5,10 +5,16 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * The direction in which to order list results, either ascending or descending.
+ */
 export const OrderByDirection = {
   Asc: "asc",
   Desc: "desc",
 } as const;
+/**
+ * The direction in which to order list results, either ascending or descending.
+ */
 export type OrderByDirection = ClosedEnum<typeof OrderByDirection>;
 
 /** @internal */

package/src/models/components/promptcreaterequest.ts

@@ -14,6 +14,9 @@ import {
   PromptLlmConfig$outboundSchema,
 } from "./promptllmconfig.js";
 
+/**
+ * Request model to create a prompt.
+ */
 export type PromptCreateRequest = {
   /**
    * The prompt name
@@ -28,16 +31,19 @@ export type PromptCreateRequest = {
    */
   type: string;
   /**
-   * The prompt text
+   * The prompt text that will be sent to the LLM at the beginning of the conversation
    */
   context?: string | null | undefined;
   /**
    * Names of tools to which the prompt has access
    */
   tools?: Array<string> | undefined;
+  /**
+   * LLM configuration for a prompt.
+   */
   llmConfig: PromptLlmConfig;
   /**
-   * Whether to include the default tools (`hangup`, `summary`) in the list of tools for the prompt. If you disable this during creation, you might want to disable it during updates as well, otherwise the default tools will be added when updating the prompt.
+   * Whether to include the default tools (`summary`, `hangup`) in the list of tools for the prompt. If you disable this during creation, you might want to disable it during updates as well, otherwise the default tools will be added when updating the prompt.
    */
   includeDefaultTools?: boolean | undefined;
 };

package/src/models/components/promptllmconfig.ts

@@ -13,6 +13,9 @@ import {
   PromptLlmProvider$outboundSchema,
 } from "./promptllmprovider.js";
 
+/**
+ * LLM configuration for a prompt.
+ */
 export type PromptLlmConfig = {
   /**
    * LLM API provider.

package/src/models/components/promptproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of prompt fields supported for filtering/sorting on list endpoint.
+ */
 export const PromptProperties = {
   Id: "id",
   Name: "name",
@@ -17,6 +20,9 @@ export const PromptProperties = {
   LastUpdatedBy: "last_updated_by",
   AgentCount: "agent_count",
 } as const;
+/**
+ * Names of prompt fields supported for filtering/sorting on list endpoint.
+ */
 export type PromptProperties = ClosedEnum<typeof PromptProperties>;
 
 /** @internal */

package/src/models/components/promptresponse.ts

@@ -21,9 +21,10 @@ import {
 } from "./toolresponse.js";
 
 /**
- * A prompt defines the behavior of an agent by delivering instructions to the LLM about how the
+ * Response model for prompt operations.
  *
  * @remarks
+ * A prompt defines the behavior of an agent by delivering instructions to the LLM about how the
  * agent should behave. A prompt can be linked to one or more agents. A prompt can also be linked to
  * tools to allow an agent using it to use those tools. For more information, see
  * [Console docs](https://docs.syllable.ai/Resources/Prompts).
@@ -42,18 +43,21 @@ export type PromptResponse = {
    */
   type: string;
   /**
-   * The prompt text
+   * The prompt text that will be sent to the LLM at the beginning of the conversation
    */
   context?: string | null | undefined;
   /**
-   * Names of the tools to which the prompt has access
+   * Names of the tools to which the prompt has access (DEPRECATED - use information from full tools field instead)
    *
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   tools?: Array<string> | undefined;
+  /**
+   * LLM configuration for a prompt.
+   */
   llmConfig: PromptLlmConfig;
   /**
-   * The prompt ID
+   * The internal ID of the prompt
    */
   id: number;
   /**
@@ -73,7 +77,7 @@ export type PromptResponse = {
    */
   agentCount?: number | null | undefined;
   /**
-   * Tools to which the prompt has access
+   * Full definitions of tools to which the prompt has access
    */
   toolsFull?: Array<ToolResponse> | null | undefined;
 };

package/src/models/components/promptupdaterequest.ts

@@ -14,6 +14,9 @@ import {
   PromptLlmConfig$outboundSchema,
 } from "./promptllmconfig.js";
 
+/**
+ * Request model to update an existing prompt.
+ */
 export type PromptUpdateRequest = {
   /**
    * The prompt name
@@ -28,16 +31,19 @@ export type PromptUpdateRequest = {
    */
   type: string;
   /**
-   * The prompt text
+   * The prompt text that will be sent to the LLM at the beginning of the conversation
    */
   context?: string | null | undefined;
   /**
    * Names of tools to which the prompt has access
    */
   tools?: Array<string> | undefined;
+  /**
+   * LLM configuration for a prompt.
+   */
   llmConfig: PromptLlmConfig;
   /**
-   * The prompt ID
+   * The internal ID of the prompt
    */
   id: number;
   /**
@@ -45,7 +51,7 @@ export type PromptUpdateRequest = {
    */
   editComments?: string | null | undefined;
   /**
-   * Whether to include the default tools (`hangup`, `summary`) in the list of tools for the prompt. If you remove one of the default tools from your prompt, you might want to disable this option so that the tool is not added again when updated.
+   * Whether to include the default tools (`summary`, `hangup`) in the list of tools for the prompt. If you remove one of the default tools from your prompt, you might want to disable this option so that the tool is not added again when updated.
    */
   includeDefaultTools?: boolean | undefined;
 };

package/src/models/components/servicecreaterequest.ts

@@ -7,6 +7,9 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Request model to create a service.
+ */
 export type ServiceCreateRequest = {
   /**
    * The name of the service

package/src/models/components/serviceproperties.ts

@@ -5,6 +5,9 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Names of service fields supported for filtering/sorting on list endpoint.
+ */
 export const ServiceProperties = {
   Id: "id",
   Name: "name",
@@ -12,6 +15,9 @@ export const ServiceProperties = {
   UpdatedAt: "updated_at",
   LastUpdatedBy: "last_updated_by",
 } as const;
+/**
+ * Names of service fields supported for filtering/sorting on list endpoint.
+ */
 export type ServiceProperties = ClosedEnum<typeof ServiceProperties>;
 
 /** @internal */

package/src/models/components/serviceresponse.ts

@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * A service is a collection of tools.
+ * Response model for service operations. A service is a collection of tools.
  */
 export type ServiceResponse = {
   /**
@@ -21,11 +21,11 @@ export type ServiceResponse = {
    */
   description: string;
   /**
-   * The ID of the service
+   * The internal ID of the service
    */
   id: number;
   /**
-   * Update comments
+   * Free text providing comment about what was updated
    */
   lastUpdatedComments?: string | null | undefined;
   /**

package/src/models/components/serviceupdaterequest.ts

@@ -8,6 +8,9 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Request model to update an existing service.
+ */
 export type ServiceUpdateRequest = {
   /**
    * The name of the service
@@ -18,11 +21,11 @@ export type ServiceUpdateRequest = {
    */
   description: string;
   /**
-   * The ID of the service
+   * The internal ID of the service
    */
   id: number;
   /**
-   * Update comments
+   * Free text providing comment about what was updated
    */
   lastUpdatedComments?: string | null | undefined;
 };

package/src/models/components/sessiondata.ts

@@ -15,10 +15,25 @@ import {
 } from "./sessionmessage.js";
 
 export type SessionData = {
+  /**
+   * Session ID
+   */
   sessionId: number;
+  /**
+   * Session source
+   */
   source: string;
+  /**
+   * Session target
+   */
   target: string;
+  /**
+   * Is test session
+   */
   isTest: boolean;
+  /**
+   * Session messages
+   */
   messages: Array<SessionMessage>;
 };
 

package/src/models/components/sessionlabel.ts

@@ -9,9 +9,10 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * A session label is associated with a given session and contains an evaluation of quality and
+ * Response model for session label operations.
  *
  * @remarks
+ * A session label is associated with a given session and contains an evaluation of quality and
  * descriptions of issues the user encountered in that session or other details.
  */
 export type SessionLabel = {
@@ -20,11 +21,11 @@ export type SessionLabel = {
    */
   sessionId: number;
   /**
-   * The type of the label
+   * The type of the label (either "auto-rating" or "human-rating")
    */
   type: string;
   /**
-   * A code describing the quality of the labeled session
+   * A code describing the quality of the labeled session (either "GOOD", "OK", "BAD", or "N/A")
    */
   code: string;
   /**
@@ -44,7 +45,7 @@ export type SessionLabel = {
    */
   id: number;
   /**
-   * The timestamp of the label creation
+   * The timestamp at which the label was created
    */
   timestamp: string;
 };

package/src/models/components/sessionlabelcreate.ts

@@ -14,11 +14,11 @@ export type SessionLabelCreate = {
    */
   sessionId: number;
   /**
-   * The type of the label
+   * The type of the label (either "auto-rating" or "human-rating")
    */
   type: string;
   /**
-   * A code describing the quality of the labeled session
+   * A code describing the quality of the labeled session (either "GOOD", "OK", "BAD", or "N/A")
    */
   code: string;
   /**

package/src/models/components/sessionmessage.ts

@@ -26,9 +26,18 @@ import {
 } from "./dialogtoolcall.js";
 
 export type SessionMessage = {
+  /**
+   * Role of dialog
+   */
   role: DialogRole;
   dialog: DialogMessage;
+  /**
+   * Tool calls
+   */
   toolCalls: Array<DialogToolCall>;
+  /**
+   * Message timestamp
+   */
   timestamp: Date;
 };