@squidcloud/client
AiSessionOptions
Type Alias AiSessionOptions
AiSessionOptions
:
Partial
<
{
agentId
:
string
;
clientId
:
string
;
rootAgentId
:
string
;
traceId
:
string
;
}
,
>
Optional settings for an AI session, allowing partial specification of identifiers.
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
@squidcloud/client
AI
AiAgentClient
AiAgentReference
AiAssistantClient
AiAudioClient
AiClient
AiImageClient
AiMatchMakingClient
MatchMaker
AiAgent
AiAgentContext
AiApiResult
AiChatPromptQuotas
AiConnectedAgentMetadata
AiConnectedIntegrationMetadata
AiContextFileOptions
AiContextMetadataAndFilter
AiContextMetadataFieldFilter
AiContextMetadataOrFilter
AiContextTextOptions
AiFileUrl
AiObserveStatusOptions
AiSearchOptions
AiSearchResultChunk
AiStatusMessage
AiTranscribeAndAskResponse
AnthropicChatOptions
AskWithVoiceResponse
BaseAiAgentChatOptions
BaseAiAudioCreateSpeechOptions
BaseAiAudioTranscribeOptions
BaseAiGenerateImageOptions
DallEOptions
ExecuteAiApiResponse
ExecuteAiQueryMultiResponse
ExecuteAiQueryOptions
ExecuteAiQueryRequest
ExecuteAiQueryResponse
ExecutedQuery
FileContextRequest
FluxOptions
GeminiChatOptions
Gpt4oTranscribeOptions
MmCategory
MmEntity
MmEntityMatch
MmFindMatchesOptions
MmListEntitiesOptions
MmMatchMaker
OpenAiChatOptions
OpenAiCreateSpeechOptions
OpenAiReasoningChatOptions
QueryAssistantOptions
StableDiffusionCoreOptions
TextContextRequest
TranscribeAndAskWithVoiceResponse
TranscribeAndChatResponse
WhisperTranscribeOptions
AgentContextRequest
AiAgentChatOptions
AiAgentResponseFormat
AiAudioCreateSpeechModelName
AiAudioCreateSpeechOptions
AiAudioModelName
AiAudioTranscribeOptions
AiAudioTranscriptionModelName
AiChatModelName
AiContextId
AiContextMetadata
AiContextMetadataFilter
AiContextMetadataSimpleFilter
AiContextMetadataValue
AiContextMetadataValueArray
AiContextType
AiEmbeddingsModelName
AiFileUrlType
AiGenerateImageOptions
AiImageModelName
AiRagType
AiRerankProvider
AiSessionOptions
AiVoyageEmbeddingsModelName
AllAiAgentChatOptions
AnthropicChatModelName
ApiKeySource
AskOptionsWithoutVoice
AssistantToolType
BaseAiContextOptions
ChatOptionsWithoutVoice
FluxModelName
GeminiChatModelName
GuardrailKeysType
GuardrailsOptions
OpenAiAudioCreateSpeechModelName
OpenAiAudioTranscribeOptions
OpenAiAudioTranscriptionModelName
OpenAiChatModelName
OpenAiCreateSpeechFormat
OpenAiImageModelName
OpenAiReasoningChatModelName
OpenAiReasoningEffort
StableDiffusionModelName
UpsertAgentRequest
UpsertAgentRequestParams
AI_AUDIO_CREATE_SPEECH_MODEL_NAMES
AI_AUDIO_TRANSCRIPTION_MODEL_NAMES
AI_CHAT_MODEL_NAMES
AI_EMBEDDINGS_MODEL_NAMES
AI_IMAGE_MODEL_NAMES
ANTHROPIC_CHAT_MODEL_NAMES
BUILT_IN_AGENT_ID
FLUX_MODEL_NAMES
GEMINI_CHAT_MODEL_NAMES
OPEN_AI_CREATE_SPEECH_FORMATS
OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES
OPENAI_AUDIO_MODEL_NAMES
OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES
OPENAI_CHAT_MODEL_NAMES
OPENAI_EMBEDDINGS_MODEL_NAMES
OPENAI_IMAGE_MODEL_NAMES
OPENAI_O1_CHAT_MODEL_NAMES
OPENAI_REASONING_CHAT_MODEL_NAMES
RAG_TYPES
RERANK_PROVIDERS
STABLE_DIFFUSION_MODEL_NAMES
VOYAGE_EMBEDDING_MODEL_NAMES
Auth
AuthData
AuthToken
AuthWithApiKey
AuthWithBearer
Auth
AuthType
AUTH_INTEGRATION_TYPES
Authentication
SquidAuthProvider
Database
BaseQueryBuilder
Changes
CollectionReference
DereferencedJoin
DocumentReference
GroupedJoin
JoinQueryBuilder
Pagination
QueryBuilder
CompositeCondition
DocIdAndData
DocsAndAlias
FieldSort
HasDereference
HasGrouped
JoinCondition
JoinFields
JoinOptions
LimitBy
PaginationOptions
PaginationState
Query
RootTableDetails
SimpleCondition
SnapshotEmitter
SquidDocIdObj
SquidDocument
VisitQueryResultsStats
Alias
CollectionName
Condition
Conditions
DocId
DocIdObj
DocIdOrDocIdObj
DocTimestamp
DocumentData
FieldName
FieldType
Grouped
Operator
OtherGroups
PrimitiveFieldType
SerializedJoinQuery
SerializedMergedQuery
SerializedQuery
SerializedSimpleQuery
TransactionId
WithDocumentReferences
ALL_OPERATORS
ARRAY_OPERATORS
BUILT_IN_DB_INTEGRATION_ID
DATA_INTEGRATION_TYPES
deserializeQuery
visitQueryResults
Metrics
QuerySquidMetricsRequest
QuerySquidMetricsResponse
QueryUserMetricsRequest
QueryUserMetricsResponse
Personal Storage
PersonalStorageClient
PsGetAccessTokenResponse
PsIndexedDocument
PsDocumentType
Queue
QueueManager
TopicName
BUILT_IN_QUEUE_INTEGRATION_ID
Secret
ApiKeysSecretClient
SecretClient
ApiKeyEntry
SecretEntry
SecretMetadata
SetSecretRequestEntry
ApiKey
SecretKey
SecretValue
Storage
StorageClient
DeleteFilesRequest
FileInDirectory
GetDownloadUrlRequest
GetDownloadUrlResponse
GetFileMetadataRequest
GetFileMetadataResponse
ListDirectoryContentsResponse
StorageFileUploadRequest
Platform
AdminClient
ApiClient
ConnectionDetails
ExtractionClient
IntegrationClient
LastUsedValueExecuteFunctionCache
ObservabilityClient
SchedulerClient
Squid
SquidClientError
WebClient
AiAgentDatabaseIntegrationOptions
AiFunctionIdWithContext
ApiEndpoint
ApiInjectionField
ApiOptions
ApiRequestField
ApiResponseField
CallApiOptions
ConcurrentCallDeduplicationOptions
DistributedLock
ExecuteFunctionCache
ExecuteFunctionCachedResult
ExecuteFunctionCachingOptions
ExecuteFunctionOptions
ExtractDataFromDocumentFileRequest
ExtractDataFromDocumentImage
ExtractDataFromDocumentOptions
ExtractDataFromDocumentPage
ExtractDataFromDocumentResponse
ExtractDataFromDocumentUrlRequest
GraphQLConnectionOptions
HttpResponse
IntegrationInfo
Metric
NativeApiCallResponse
OpenApiDiscoveryOptions
OpenApiResponse
QueryMetricsRequestCommon
QueryMetricsResponseCommon
QueryMetricsResultGroup
RunContext
SchedulerConfig
SchedulerInfo
SquidOptions
UpdateSchedulerOptions
UpdateSchedulersRequest
WebAiSearchCitedUrl
WebAiSearchRequest
WebAiSearchResponse
WebGetUrlContentRequest
WebGetUrlContentResponse
WebShortUrlDeleteRequest
WebShortUrlRequest
WebShortUrlResponse
AiAgentId
AiFunctionId
ApiEndpointId
ApiInjectionFieldType
ApiInjectionParameterLocation
ApiInjectionSchema
ApiParameterLocation
ApiResponseParameterLocation
AppId
ClientConnectionState
ClientId
ClientRequestId
CollectionSchema
DeepRecord
DocumentExtractionMethod
EnvironmentId
ExecuteFunctionArgsComparator
ExecuteFunctionCacheLookupResult
FieldOf
FieldPath
FunctionName
HttpMethod
HttpStatusCode
IntegrationApiEndpoints
IntegrationId
IntegrationSchemaType
IntegrationType
MetricDomain
MetricFunction
MetricIntervalAlignment
MetricReport
PartialBy
Paths
PropertySchema
QueryMetricsRequest
QueryMetricsResponse
QueryMetricsResultPoint
ServiceFunctionName
ServiceName
SquidDeveloperId
SquidDocId
SquidMetricName
SquidRegion
TopLevelPropertySchema
UnionKeys
API_INJECTION_FIELD_TYPES
BUILT_IN_STORAGE_INTEGRATION_ID
CLIENT_CONNECTION_STATES
compareArgsByReference
compareArgsBySerializedValue
DEFAULT_SHORT_ID_LENGTH
ENVIRONMENT_IDS
GRAPHQL_INTEGRATION_TYPES
HTTP_INTEGRATION_TYPES
HttpStatus
INTEGRATION_SCHEMA_TYPES
INTEGRATION_TYPES
METRIC_DOMAIN
METRIC_FUNCTIONS
METRIC_INTERVAL_ALIGNMENT
SQUID_METRIC_NAMES
SQUID_REGIONS
generateId
generateShortId
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R
Optional settings for an AI session, allowing partial specification of identifiers.