algolia_client_agent_studio
library
Enums
-
AdvancedSyntaxFeatures
-
AdvancedSyntaxFeatures.
-
AgentStatus
-
-
AlternativesAsExact
-
AlternativesAsExact.
-
CallType
-
Indicate whether the HTTP call performed is of type read (GET) or write
(POST, PUT ..). Used to determine which timeout duration to use.
-
CompatibilityMode
-
Support Compatibility modes for the completion API.
-
ExactOnSingleWordQuery
-
Determines how the Exact ranking criterion is computed when the search query has only one word. -
attribute. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip". - none. The Exact ranking criterion is ignored on single-word searches. - word. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.
-
MemoryType
-
Memory types implemented so far. Follows LangMem's ontology: https://langchain-ai.github.io/langmem/concepts/conceptual_guide/#memory-types.
-
MessageRole
-
Role of a message in the conversation.
-
ProviderName
-
-
QueryType
-
Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (
prefixLast). To turn off prefix search, use prefixNone. Avoid prefixAll, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see Prefix searching.
-
RemoveWordsIfNoResults
-
Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. -
none. No words are removed when a query doesn't return results. - lastWords. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - firstWords. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - allOptional. Treat all words as optional. For more information, see Remove words to improve results.
-
RequestMethod
-
Provides enumerated HTTP verbs
-
SupportedLanguage
-
ISO code for a supported language.
-
ToolResultOutputType
-
The valid 'type' of tool results.
-
ToolState
-
-
TypoToleranceEnum
-
min. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - strict. Return matches with the two lowest numbers of typos. With strict, the Typo ranking criterion is applied first in the ranking setting.
-
VoteEnum
-
Constants
-
defaultMaxRetries
→ const int
-
Default maximum number of retries for chunked helpers and wait operations.
-
defaultReplaceAllObjectsMaxRetries
→ const int
-
Default maximum number of retries used by
replaceAllObjects.
-
platformRequestIdAsQueryParameter
→ const bool
-
Whether the platform mints the Request-ID as the
x-algolia-request-id
query parameter instead of the header. Browsers must: the header is not
covered by the API's CORS allow-list. Also the fallback for unknown
platforms (wasm web included), where only the query parameter is safe.
-
The name of the header carrying the Request-ID minted when a client supports it.
-
requestIdQueryParameter
→ const String
-
The name of the query parameter carrying a Request-ID; the server consults
it only when the header is absent.
Functions
-
generateRequestId()
→ String
-
Returns a fresh 11-character base62 identifier suitable for the Request-ID
header.
-
Whether the given headers already carry a Request-ID entry, whatever its casing.
-
hasRequestIdQueryParameter(Map<String, dynamic>? queryParameters)
→ bool
-
Whether the given query parameters already carry an
x-algolia-request-id
entry, whatever its casing; a minted header would shadow it.
-
mintedRequestIdOptions({bool asQueryParameter = platformRequestIdAsQueryParameter})
→ RequestOptions
-
Request options carrying a freshly minted Request-ID on the given channel:
the header on native platforms, the query parameter on the web.
