@squidcloud/jira-jsm-client 1.0.511 → 1.0.513

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,7 @@
1
1
  import { JSONSchema } from 'json-schema-typed';
2
2
  import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, CanonicalReasoningEffort, EmbeddingModelIdSpec, GeminiChatModelName, GrokChatModelName, ModelIdSpec, OpenAiAudioCreateSpeechModelName, OpenAiAudioTranscriptionModelName, OpenAiChatModelName, OpenAiCreateSpeechFormat, OpenAiImageModelName, VendorAiChatModelName } from './ai-common.public-types';
3
3
  import { AiContextMetadata, AiContextMetadataFilter, AiKnowledgeBaseContextType, AiRagType } from './ai-knowledge-base.public-types';
4
+ import { AiOntologyId } from './ai-ontology.public-types';
4
5
  import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
5
6
  import { AiAgentId, AiContextId, AiKnowledgeBaseId, AppId, IntegrationId } from './communication.public-types';
6
7
  import { DocumentExtractionMethod } from './extraction.public-types';
@@ -624,6 +625,11 @@ export interface BaseAiChatOptions {
624
625
  * enable downloads. Default to false (citations render source names only).
625
626
  */
626
627
  allowSourceDownloads?: boolean;
628
+ /**
629
+ * The ontology whose accepted relationships this agent's answers and database queries follow. Honored ONLY from the
630
+ * agent's stored options; the per-request value is ignored.
631
+ */
632
+ ontologyId?: AiOntologyId;
627
633
  /**
628
634
  * The format of the response from the AI model. Defaults to 'text'. A `json_schema` format is
629
635
  * refused for a model whose provider has no way to carry a schema — see
@@ -1050,6 +1056,12 @@ export type UpsertAgentRequest = Omit<AiAgent, 'createdAt' | 'updatedAt' | 'opti
1050
1056
  * @category AI
1051
1057
  */
1052
1058
  export declare const AGENT_STATUS_TITLE_AGENT_RESPONSE = "Agent Response";
1059
+ /**
1060
+ * Status update title broadcast when the agent's model fails and the `ask` is retried on its backup model. Its audit
1061
+ * log entry carries the failed model and its usage in its tags; the backup's attempt records the job's response.
1062
+ * @category AI
1063
+ */
1064
+ export declare const AGENT_STATUS_TITLE_MODEL_FAILOVER = "Primary Model Failed";
1053
1065
  /**
1054
1066
  * Status update title broadcast when the agent invokes a knowledge-base
1055
1067
  * callable. A matching invocation produces a single event with this title.
@@ -46,7 +46,7 @@ export declare const AI_CODE_INTERPRETER_PROVIDER_TYPES: readonly ["openai", "an
46
46
  * Public OpenAI chat model names (active models only).
47
47
  * @category AI
48
48
  */
49
- export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra"];
49
+ export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-luna", "gpt-6.1-terra", "gpt-6.2-astra", "gpt-6.2-sol"];
50
50
  /**
51
51
  * Public Gemini chat model names (active models only).
52
52
  * @category AI
@@ -66,7 +66,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-fable-5-2", "
66
66
  * The supported AI model names.
67
67
  * @category AI
68
68
  */
69
- export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-astra", "gpt-6-luna", "gpt-6.1-sol", "gpt-6.1-terra", "claude-fable-5-2", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-carbon", "gemini-4-argon", "gemini-4-hydrogen", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
69
+ export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5.6-sol", "gpt-5.6-luna", "gpt-6-luna", "gpt-6.1-terra", "gpt-6.2-astra", "gpt-6.2-sol", "claude-fable-5-2", "claude-haiku-5-5", "claude-opus-5-5", "claude-sonnet-5-5", "gemini-4-carbon", "gemini-4-argon", "gemini-4-hydrogen", "gemini-3.8-flash", "gemini-3.5-flash-lite", "grok-4.6", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
70
70
  /** Checks if the given model name is a global AI chat model name. */
71
71
  export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
72
72
  /**
@@ -61,101 +61,62 @@ export interface AiKnowledgeBase {
61
61
  accessControl?: AiKnowledgeBaseAccessControl;
62
62
  /**
63
63
  * Binds the knowledge base to content that lives outside Squid. Such a knowledge base is read-only: its
64
- * content cannot be upserted or deleted, and searches run against the source. It is set by the
65
- * `azure_ai_search` integration whose `knowledgeBaseId` names the knowledge base, never by an upsert.
64
+ * content cannot be upserted or deleted, and searches run against the source. It is set by the integration
65
+ * whose `knowledgeBaseId` names the knowledge base, never by an upsert.
66
66
  */
67
67
  externalSource?: AiKnowledgeBaseExternalSource;
68
68
  /** The timestamp the knowledge base was last updated */
69
69
  updatedAt: Date;
70
70
  }
71
71
  /**
72
- * Maps the fields of an Azure AI Search index to the roles Squid reads them in.
73
- * @category AI
74
- */
75
- export interface AzureAiSearchFieldRoles {
76
- /** The key field of the index. */
77
- key: string;
78
- /** The parent document key of a chunked index (index projections). Absent when each record is a whole document. */
79
- parentKey?: string;
80
- /** The field holding the document title. */
81
- title?: string;
82
- /** The retrievable text fields that make up a record's content, in reading order. */
83
- content: Array<string>;
84
- /** The field holding a link to the source document. */
85
- url?: string;
86
- /** A filterable, sortable timestamp field. Enables incremental sync of the entity graph. */
87
- lastModified?: string;
88
- /** Filterable or facetable fields exposed as knowledge base metadata and facet candidates. */
89
- metadata: Array<string>;
90
- /** Vector fields that have a vectorizer, so a vector search can send text and let the index embed it. */
91
- vector?: Array<string>;
92
- /** The metadata and security fields that hold a collection of values; filters on them match any element. */
93
- collections?: Array<string>;
94
- }
95
- /**
96
- * The document-level security models of an Azure AI Search index. See {@link AzureAiSearchSecurity}.
97
- * @category AI
98
- */
99
- export declare const AZURE_AI_SEARCH_SECURITY_MODES: readonly ["none", "filter", "nativeAcl"];
100
- /**
101
- * How Squid restricts a search of an Azure AI Search index to what its caller may read.
72
+ * How an external source restricts a read to what its caller may see.
102
73
  *
103
- * - `'none'`: the index has no document-level security.
104
- * - `'filter'`: the index has a security field. The caller's values come from the knowledge base's
105
- * `accessControl.scopeResolver`; a record is visible when the field holds one of them or one of `publicValues`.
106
- * - `'nativeAcl'`: the index enforces its own ACLs. The caller's Entra token is supplied per request in
107
- * `integrationAccessTokens` under the integration's id; a search without it fails. Search works as the
108
- * caller, but Squid's own reads see only the records every user may read, so the knowledge base has no
109
- * facet concepts and its index card is written from the index definition alone.
74
+ * - `'none'`: the source has no document-level security.
75
+ * - `'callerScopes'`: a record is visible when it holds one of the caller's scopes, which the knowledge base's
76
+ * `accessControl.scopeResolver` resolves.
77
+ * - `'callerToken'`: the source enforces its own ACLs with the caller's token, supplied per request in
78
+ * `integrationAccessTokens` under the integration's id. Squid's own reads see only the records every caller
79
+ * may read.
110
80
  *
111
81
  * @category AI
112
82
  */
113
- export type AzureAiSearchSecurity = {
114
- /** The index has no document-level security. */
115
- mode: 'none';
116
- } | {
117
- /** The index is filtered on a security field. */
118
- mode: 'filter';
119
- /** The filterable security field: a string, or a collection of strings. */
120
- field: string;
121
- /** Values of the security field that mark a record as visible to every caller. */
122
- publicValues?: Array<string>;
123
- } | {
124
- /** The index enforces native ACLs with the caller's Entra token. */
125
- mode: 'nativeAcl';
126
- };
83
+ export type AiKnowledgeBaseExternalDocumentSecurity = 'none' | 'callerScopes' | 'callerToken';
127
84
  /**
128
- * Marks a knowledge base whose content lives in a customer-owned Azure AI Search index. Squid queries the
129
- * index with the access the integration grants and never modifies it.
85
+ * What Squid knows about an external source whatever its type. The integration's connector reports it when the
86
+ * integration is saved.
130
87
  * @category AI
131
88
  */
132
- export interface AiKnowledgeBaseAzureAiSearchSource {
133
- /** The kind of external source. */
134
- type: 'azureAiSearch';
135
- /** The `azure_ai_search` integration that holds the connection to the search service. */
136
- integrationId: IntegrationId;
137
- /** The name of the index. */
138
- indexName: string;
139
- /** Which index fields Squid reads, and as what. */
140
- fieldRoles: AzureAiSearchFieldRoles;
141
- /** How searches are restricted to what the caller may read. */
142
- security: AzureAiSearchSecurity;
143
- /**
144
- * The semantic configuration that hybrid searches rank with. Semantic ranking is billed to the owner of the
145
- * search service. Omitted ⇒ no semantic ranking.
146
- */
147
- semanticConfiguration?: string;
148
- /**
149
- * Minutes between the sync scans that keep the entity graph in step with the index. Only used while
150
- * `graphRag.enabled` is set. Defaults to 60.
151
- */
152
- syncIntervalMinutes?: number;
89
+ export interface AiKnowledgeBaseExternalSourceTraits {
90
+ /** A one-line name of the source for people and agents, such as `Azure AI Search index "handbook"`. */
91
+ label: string;
92
+ /** What the integration reads in the source, such as an index name. Fixed once the knowledge base is bound. */
93
+ target: string;
94
+ /** How a read is restricted to what its caller may see. */
95
+ documentSecurity: AiKnowledgeBaseExternalDocumentSecurity;
96
+ /** True when a document spans several records of the source. */
97
+ chunked: boolean;
98
+ /** True when the source embeds the text of a vector query itself. */
99
+ embedsQueries: boolean;
100
+ /** True when the source records when each record last changed, so a sync reads only what changed. */
101
+ incrementalSync: boolean;
102
+ /** The source fields the knowledge base exposes as metadata. */
103
+ metadataFields: Array<string>;
153
104
  }
154
105
  /**
155
- * Where the content of an external, read-only knowledge base lives.
106
+ * Where the content of an external, read-only knowledge base lives. Squid reads the source with the access the
107
+ * integration grants and never modifies it.
156
108
  * @category AI
157
109
  */
158
- export type AiKnowledgeBaseExternalSource = AiKnowledgeBaseAzureAiSearchSource;
110
+ export interface AiKnowledgeBaseExternalSource {
111
+ /** The type of the integration that serves the source. */
112
+ type: string;
113
+ /** The integration that holds the connection to the source. */
114
+ integrationId: IntegrationId;
115
+ /** What Squid knows about the source whatever its type. */
116
+ traits: AiKnowledgeBaseExternalSourceTraits;
117
+ /** How the integration's connector reads the source. Only that connector reads them. */
118
+ settings: Record<string, unknown>;
119
+ }
159
120
  /**
160
121
  * The access-control modes a knowledge base can be in. See {@link AiKnowledgeBaseAccessControl}.
161
122
  * @category AI
@@ -2761,22 +2722,17 @@ export type KnowledgeBaseExternalSourceTier = 1 | 2;
2761
2722
  * @category AI
2762
2723
  */
2763
2724
  export interface KnowledgeBaseExternalSourcePrerequisite {
2764
- /** A stable identifier of the prerequisite. */
2765
- id: KnowledgeBaseExternalSourcePrerequisiteId;
2725
+ /** A stable identifier of the prerequisite, which the source's connector names. */
2726
+ id: string;
2766
2727
  /** The lowest tier that needs it. */
2767
2728
  tier: KnowledgeBaseExternalSourceTier;
2768
- /** Whether the index provides it: `'unknown'` when the integration may not read what answers that. */
2729
+ /** Whether the source provides it: `'unknown'` when the integration may not read what answers that. */
2769
2730
  status: 'met' | 'unmet' | 'unknown';
2770
2731
  /** True when the tier cannot run without it; false when the tier runs degraded. */
2771
2732
  required: boolean;
2772
2733
  /** What was found, and what it means for the tier. */
2773
2734
  message: string;
2774
2735
  }
2775
- /**
2776
- * The prerequisites the binding of an external source reports.
2777
- * @category AI
2778
- */
2779
- export type KnowledgeBaseExternalSourcePrerequisiteId = 'definitionReadable' | 'documentSecurityKnown' | 'contentRetrievable' | 'vectorizer' | 'keyFilterableSortable' | 'withinScanLimit' | 'timestampField' | 'noDocumentSecurity';
2780
2736
  /**
2781
2737
  * Request structure for reading the state of an external knowledge base's semantic layer.
2782
2738
  * @category AI