graphlit-client 1.0.20241210001 → 1.0.20241212001

package/dist/client.d.ts

@@ -73,9 +73,9 @@ declare class Graphlit {
     reviseText(prompt: string, text: string, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseTextMutation>;
     reviseContent(prompt: string, content: Types.EntityReferenceInput, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.ReviseContentMutation>;
     prompt(prompt: string, specification?: Types.EntityReferenceInput, messages?: [Types.ConversationMessageInput], correlationId?: string): Promise<Types.PromptMutation>;
-    formatConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.FormatConversationMutation>;
+    formatConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, includeDetails?: boolean, correlationId?: string): Promise<Types.FormatConversationMutation>;
     completeConversation(completion: string, id: string, correlationId?: string): Promise<Types.CompleteConversationMutation>;
-    promptConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, tools?: [Types.ToolDefinitionInput], requireTool?: boolean, correlationId?: string): Promise<Types.PromptConversationMutation>;
+    promptConversation(prompt: string, id?: string, specification?: Types.EntityReferenceInput, tools?: [Types.ToolDefinitionInput], requireTool?: boolean, includeDetails?: boolean, correlationId?: string): Promise<Types.PromptConversationMutation>;
     continueConversation(id: string, responses: [Types.ConversationToolResponseInput], correlationId?: string): Promise<Types.ContinueConversationMutation>;
     publishConversation(id: string, connector: Types.ContentPublishingConnectorInput, name?: string, workflow?: Types.EntityReferenceInput, correlationId?: string): Promise<Types.PublishConversationMutation>;
     suggestConversation(id: string, count?: number, correlationId?: string): Promise<Types.SuggestConversationMutation>;

package/dist/client.js

@@ -423,9 +423,9 @@ class Graphlit {
             return this.mutateAndCheckError(Documents.Prompt, { prompt: prompt, specification: specification, messages: messages, correlationId: correlationId });
         });
     }
-    formatConversation(prompt, id, specification, correlationId) {
+    formatConversation(prompt, id, specification, includeDetails, correlationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.mutateAndCheckError(Documents.FormatConversation, { prompt: prompt, id: id, specification: specification, correlationId: correlationId });
+            return this.mutateAndCheckError(Documents.FormatConversation, { prompt: prompt, id: id, specification: specification, includeDetails: includeDetails, correlationId: correlationId });
         });
     }
     completeConversation(completion, id, correlationId) {
@@ -433,9 +433,9 @@ class Graphlit {
             return this.mutateAndCheckError(Documents.CompleteConversation, { completion: completion, id: id, correlationId: correlationId });
         });
     }
-    promptConversation(prompt, id, specification, tools, requireTool, correlationId) {
+    promptConversation(prompt, id, specification, tools, requireTool, includeDetails, correlationId) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.mutateAndCheckError(Documents.PromptConversation, { prompt: prompt, id: id, specification: specification, tools: tools, requireTool: requireTool, correlationId: correlationId });
+            return this.mutateAndCheckError(Documents.PromptConversation, { prompt: prompt, id: id, specification: specification, tools: tools, requireTool: requireTool, includeDetails: includeDetails, correlationId: correlationId });
         });
     }
     continueConversation(id, responses, correlationId) {

package/dist/generated/graphql-documents.js

@@ -2294,11 +2294,12 @@ exports.DeleteConversations = (0, graphql_tag_1.default) `
 }
     `;
 exports.FormatConversation = (0, graphql_tag_1.default) `
-    mutation FormatConversation($prompt: String!, $id: ID, $specification: EntityReferenceInput, $correlationId: String) {
+    mutation FormatConversation($prompt: String!, $id: ID, $specification: EntityReferenceInput, $includeDetails: Boolean, $correlationId: String) {
   formatConversation(
     prompt: $prompt
     id: $id
     specification: $specification
+    includeDetails: $includeDetails
     correlationId: $correlationId
   ) {
     conversation {
@@ -2871,13 +2872,14 @@ exports.Prompt = (0, graphql_tag_1.default) `
 }
     `;
 exports.PromptConversation = (0, graphql_tag_1.default) `
-    mutation PromptConversation($prompt: String!, $id: ID, $specification: EntityReferenceInput, $tools: [ToolDefinitionInput!], $requireTool: Boolean, $correlationId: String) {
+    mutation PromptConversation($prompt: String!, $id: ID, $specification: EntityReferenceInput, $tools: [ToolDefinitionInput!], $requireTool: Boolean, $includeDetails: Boolean, $correlationId: String) {
   promptConversation(
     prompt: $prompt
     id: $id
     specification: $specification
     tools: $tools
     requireTool: $requireTool
+    includeDetails: $includeDetails
     correlationId: $correlationId
   ) {
     conversation {
@@ -6437,6 +6439,7 @@ exports.GetSpecification = (0, graphql_tag_1.default) `
       embedCitations
       flattenCitations
       enableFacets
+      disableGuardrails
       messagesWeight
       contentsWeight
     }
@@ -6741,6 +6744,7 @@ exports.QuerySpecifications = (0, graphql_tag_1.default) `
         embedCitations
         flattenCitations
         enableFacets
+        disableGuardrails
         messagesWeight
         contentsWeight
       }

package/dist/generated/graphql-types.d.ts

@@ -615,6 +615,10 @@ export declare enum AzureDocumentIntelligenceModels {
     ReadOcr = "READ_OCR",
     /** Receipt */
     Receipt = "RECEIPT",
+    /** Bank Check (US) */
+    UsBankCheck = "US_BANK_CHECK",
+    /** Bank Statement (US) */
+    UsBankStatement = "US_BANK_STATEMENT",
     /** Health Insurance Card (US) */
     UsHealthInsuranceCard = "US_HEALTH_INSURANCE_CARD",
     /** Marriage Certificate (US) */
@@ -625,6 +629,8 @@ export declare enum AzureDocumentIntelligenceModels {
     UsMortgage1008 = "US_MORTGAGE1008",
     /** Mortgage closing disclosure (US) */
     UsMortgageDisclosure = "US_MORTGAGE_DISCLOSURE",
+    /** Pay Stub (US) */
+    UsPayStub = "US_PAY_STUB",
     /** 1098 Form (US) */
     UsTaxForm1098 = "US_TAX_FORM1098",
     /** 1098E Form (US) */
@@ -1773,6 +1779,52 @@ export type ConversationCitation = {
     /** The citation text. */
     text: Scalars['String']['output'];
 };
+/** Represents the RAG pipeline details for a prompted conversation. */
+export type ConversationDetails = {
+    __typename?: 'ConversationDetails';
+    /** The LLM assistant message, prior to parsing JSON guardrails. */
+    assistantMessage?: Maybe<Scalars['String']['output']>;
+    /** The LLM completion token limit. */
+    completionTokenLimit?: Maybe<Scalars['Int']['output']>;
+    /** The formatted RAG instructions. */
+    formattedInstructions?: Maybe<Scalars['String']['output']>;
+    /** The formatted observed entities. */
+    formattedObservables?: Maybe<Scalars['String']['output']>;
+    /** The formatted sources. */
+    formattedSources?: Maybe<Scalars['String']['output']>;
+    /** The formatted LLM tools. */
+    formattedTools?: Maybe<Scalars['String']['output']>;
+    /** The LLM conversation messages. */
+    messages?: Maybe<Array<Maybe<ConversationMessage>>>;
+    /** The LLM model description. */
+    model?: Maybe<Scalars['String']['output']>;
+    /** The LLM service type. */
+    modelService?: Maybe<ModelServiceTypes>;
+    /** The number of observable entities after retrieval. */
+    observableCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of observable entities after reranking. */
+    rankedObservableCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of content sources after reranking. */
+    rankedSourceCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of tools after reranking. */
+    rankedToolCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of observable entities after rendering. */
+    renderedObservableCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of content sources after rendering. */
+    renderedSourceCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of tools after rendering. */
+    renderedToolCount?: Maybe<Scalars['Int']['output']>;
+    /** The number of content sources after retrieval. */
+    sourceCount?: Maybe<Scalars['Int']['output']>;
+    /** JSON representation of the source to content mapping. */
+    sources?: Maybe<Scalars['String']['output']>;
+    /** Whether the LLM supports tool calling. */
+    supportsToolCalling?: Maybe<Scalars['Boolean']['output']>;
+    /** The LLM prompt token limit. */
+    tokenLimit?: Maybe<Scalars['Int']['output']>;
+    /** The number of tools. */
+    toolCount?: Maybe<Scalars['Int']['output']>;
+};
 /** Represents a filter for conversations. */
 export type ConversationFilter = {
     /** Filter by similar conversations. */
@@ -1830,7 +1882,7 @@ export type ConversationMessage = {
     completionTime?: Maybe<Scalars['TimeSpan']['output']>;
     /** The conversation message. */
     message?: Maybe<Scalars['String']['output']>;
-    /** The LLM description, only provided with assistant role. */
+    /** The LLM model description, only provided with assistant role. */
     model?: Maybe<Scalars['String']['output']>;
     /** The LLM service type, only provided with assistant role. */
     modelService?: Maybe<ModelServiceTypes>;
@@ -1881,6 +1933,8 @@ export type ConversationStrategy = {
     __typename?: 'ConversationStrategy';
     /** The weight of contents within prompt context, in range [0.0 - 1.0]. */
     contentsWeight?: Maybe<Scalars['Float']['output']>;
+    /** Disable JSON guardrails, if system prompt asks for non-JSON output format. */
+    disableGuardrails?: Maybe<Scalars['Boolean']['output']>;
     /** Embed content citations into completed converation messages. */
     embedCitations?: Maybe<Scalars['Boolean']['output']>;
     /** Provide content facets with completed conversation. */
@@ -1898,6 +1952,8 @@ export type ConversationStrategy = {
 export type ConversationStrategyInput = {
     /** The weight of contents within prompt context, in range [0.0 - 1.0]. */
     contentsWeight?: InputMaybe<Scalars['Float']['input']>;
+    /** Disable JSON guardrails, if system prompt asks for non-JSON output format. */
+    disableGuardrails?: InputMaybe<Scalars['Boolean']['input']>;
     /** Embed content citations into completed converation messages. */
     embedCitations?: InputMaybe<Scalars['Boolean']['input']>;
     /** Provide content facets with completed conversation. */
@@ -1922,6 +1978,8 @@ export declare enum ConversationStrategyTypes {
 export type ConversationStrategyUpdateInput = {
     /** The weight of contents within prompt context, in range [0.0 - 1.0]. */
     contentsWeight?: InputMaybe<Scalars['Float']['input']>;
+    /** Disable JSON guardrails, if system prompt asks for non-JSON output format. */
+    disableGuardrails?: InputMaybe<Scalars['Boolean']['input']>;
     /** Embed content citations into completed converation messages. */
     embedCitations?: InputMaybe<Scalars['Boolean']['input']>;
     /** Provide content facets with completed conversation. */
@@ -3688,7 +3746,9 @@ export declare enum GoogleModels {
     /** Gemini 1.5 Pro (001 version) */
     Gemini_1_5Pro_001 = "GEMINI_1_5_PRO_001",
     /** Gemini 1.5 Pro (002 version) */
-    Gemini_1_5Pro_002 = "GEMINI_1_5_PRO_002"
+    Gemini_1_5Pro_002 = "GEMINI_1_5_PRO_002",
+    /** Gemini 2.0 Flash (Experimental) */
+    Gemini_2_0FlashExperimental = "GEMINI_2_0_FLASH_EXPERIMENTAL"
 }
 /** Represents a knowledge graph. */
 export type Graph = {
@@ -6951,6 +7011,7 @@ export type MutationCompleteConversationArgs = {
 export type MutationContinueConversationArgs = {
     correlationId?: InputMaybe<Scalars['String']['input']>;
     id: Scalars['ID']['input'];
+    includeDetails?: InputMaybe<Scalars['Boolean']['input']>;
     responses: Array<ConversationToolResponseInput>;
 };
 export type MutationCreateAlertArgs = {
@@ -7407,6 +7468,7 @@ export type MutationExtractTextArgs = {
 export type MutationFormatConversationArgs = {
     correlationId?: InputMaybe<Scalars['String']['input']>;
     id?: InputMaybe<Scalars['ID']['input']>;
+    includeDetails?: InputMaybe<Scalars['Boolean']['input']>;
     prompt: Scalars['String']['input'];
     specification?: InputMaybe<EntityReferenceInput>;
 };
@@ -7486,6 +7548,7 @@ export type MutationPromptArgs = {
 export type MutationPromptConversationArgs = {
     correlationId?: InputMaybe<Scalars['String']['input']>;
     id?: InputMaybe<Scalars['ID']['input']>;
+    includeDetails?: InputMaybe<Scalars['Boolean']['input']>;
     prompt: Scalars['String']['input'];
     requireTool?: InputMaybe<Scalars['Boolean']['input']>;
     specification?: InputMaybe<EntityReferenceInput>;
@@ -9424,6 +9487,8 @@ export type PromptConversation = {
     __typename?: 'PromptConversation';
     /** The completed conversation. */
     conversation?: Maybe<EntityReference>;
+    /** The RAG pipeline details for debugging purposes. */
+    details?: Maybe<ConversationDetails>;
     /** The content facets referenced by the completed conversation message. */
     facets?: Maybe<Array<Maybe<ContentFacet>>>;
     /** The knowledge graph generated from the retrieved contents. */
@@ -14534,6 +14599,7 @@ export type FormatConversationMutationVariables = Exact<{
     prompt: Scalars['String']['input'];
     id?: InputMaybe<Scalars['ID']['input']>;
     specification?: InputMaybe<EntityReferenceInput>;
+    includeDetails?: InputMaybe<Scalars['Boolean']['input']>;
     correlationId?: InputMaybe<Scalars['String']['input']>;
 }>;
 export type FormatConversationMutation = {
@@ -15195,6 +15261,7 @@ export type PromptConversationMutationVariables = Exact<{
     specification?: InputMaybe<EntityReferenceInput>;
     tools?: InputMaybe<Array<ToolDefinitionInput> | ToolDefinitionInput>;
     requireTool?: InputMaybe<Scalars['Boolean']['input']>;
+    includeDetails?: InputMaybe<Scalars['Boolean']['input']>;
     correlationId?: InputMaybe<Scalars['String']['input']>;
 }>;
 export type PromptConversationMutation = {
@@ -19511,6 +19578,7 @@ export type GetSpecificationQuery = {
             embedCitations?: boolean | null;
             flattenCitations?: boolean | null;
             enableFacets?: boolean | null;
+            disableGuardrails?: boolean | null;
             messagesWeight?: number | null;
             contentsWeight?: number | null;
         } | null;
@@ -19852,6 +19920,7 @@ export type QuerySpecificationsQuery = {
                 embedCitations?: boolean | null;
                 flattenCitations?: boolean | null;
                 enableFacets?: boolean | null;
+                disableGuardrails?: boolean | null;
                 messagesWeight?: number | null;
                 contentsWeight?: number | null;
             } | null;

package/dist/generated/graphql-types.js

@@ -71,6 +71,10 @@ var AzureDocumentIntelligenceModels;
     AzureDocumentIntelligenceModels["ReadOcr"] = "READ_OCR";
     /** Receipt */
     AzureDocumentIntelligenceModels["Receipt"] = "RECEIPT";
+    /** Bank Check (US) */
+    AzureDocumentIntelligenceModels["UsBankCheck"] = "US_BANK_CHECK";
+    /** Bank Statement (US) */
+    AzureDocumentIntelligenceModels["UsBankStatement"] = "US_BANK_STATEMENT";
     /** Health Insurance Card (US) */
     AzureDocumentIntelligenceModels["UsHealthInsuranceCard"] = "US_HEALTH_INSURANCE_CARD";
     /** Marriage Certificate (US) */
@@ -81,6 +85,8 @@ var AzureDocumentIntelligenceModels;
     AzureDocumentIntelligenceModels["UsMortgage1008"] = "US_MORTGAGE1008";
     /** Mortgage closing disclosure (US) */
     AzureDocumentIntelligenceModels["UsMortgageDisclosure"] = "US_MORTGAGE_DISCLOSURE";
+    /** Pay Stub (US) */
+    AzureDocumentIntelligenceModels["UsPayStub"] = "US_PAY_STUB";
     /** 1098 Form (US) */
     AzureDocumentIntelligenceModels["UsTaxForm1098"] = "US_TAX_FORM1098";
     /** 1098E Form (US) */
@@ -743,6 +749,8 @@ var GoogleModels;
     GoogleModels["Gemini_1_5Pro_001"] = "GEMINI_1_5_PRO_001";
     /** Gemini 1.5 Pro (002 version) */
     GoogleModels["Gemini_1_5Pro_002"] = "GEMINI_1_5_PRO_002";
+    /** Gemini 2.0 Flash (Experimental) */
+    GoogleModels["Gemini_2_0FlashExperimental"] = "GEMINI_2_0_FLASH_EXPERIMENTAL";
 })(GoogleModels || (exports.GoogleModels = GoogleModels = {}));
 /** GraphRAG strategies */
 var GraphStrategyTypes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphlit-client",
-  "version": "1.0.20241210001",
+  "version": "1.0.20241212001",
   "description": "Graphlit API TypeScript Client",
   "main": "dist/client.js",
   "types": "dist/client.d.ts",