The identity and technical contract details declared by the specification.
inference._types.FireworksAITaskType
string
inference._types.ThinkingConfig
object
1 property
inference._types.AmazonBedrockTaskSettings
object
4 properties
inference._types.CohereSimilarityType
string
inference._types.DenseEmbeddingResult
object
The dense embedding result object for float representation
1 property
1 required
_types.AcknowledgedResponseBase
object
1 property
1 required
inference._types.CohereTruncateType
string
inference._types.AmazonBedrockServiceSettings
object
6 properties
4 required
inference._types.TaskTypeAmazonBedrock
string
inference.rerank.RerankInputObject
object
An object describing a single input for the rerank task, which additionally allows specifying non-text inputs, such as images.
3 properties
2 required
inference._types.InferenceEndpointInfoElasticsearch
inference._types.ContextualAIServiceType
string
inference._types.AzureAiStudioServiceSettings
object
5 properties
4 required
inference._types.CompletionToolFunction
object
The completion tool function definition.
4 properties
1 required
inference._types.VoyageAIServiceSettings
object
4 properties
1 required
inference._types.GoogleAiStudioTaskType
string
_types.StreamResult
object
_types.EpochTimeUnitMillis
inference._types.EncryptedReasoningDetail
The reasoning detail with encrypted reasoning data that may be redacted or protected.
inference._types.InferenceEndpointInfoOpenShiftAi
inference._types.OpenShiftAiServiceType
string
inference._types.HuggingFaceServiceSettings
object
4 properties
2 required
inference._types.TaskTypeOpenShiftAi
string
inference._types.TaskTypeCustom
string
inference._types.ContentObject
object
An object style representation of a single portion of a conversation.
4 properties
4 required
inference._types.AzureAiStudioTaskType
string
inference._types.ElserServiceType
string
inference._types.CohereEmbeddingType
string
inference._types.GoogleModelGardenProvider
string
inference._types.NvidiaServiceSettings
object
6 properties
2 required
inference._types.EmbeddingContentObjectItem
object
An object containing the input data for a single item for the model to embed.
3 properties
2 required
inference._types.FireworksAITaskSettings
object
2 properties
inference._types.CohereTaskType
string
inference._types.InferenceEndpoint
object
Configuration options when storing the inference endpoint
4 properties
2 required
inference._types.TaskTypeContextualAI
string
inference._types.TaskType
string
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
inference._types.TaskTypeFireworksAI
string
inference._types.InferenceEndpointInfoJinaAi
inference.rerank.RerankQuery
Query input for the rerank task. Either a string, or an object. The object form additionally allows specifying non-text inputs, such as images. info Only the e…
inference._types.FireworksAIServiceSettings
object
6 properties
2 required
inference._types.RankedDocument
object
The rerank result object representing a single ranked document id: the original index of the document in the request relevancescore: the relevancescore of the…
3 properties
2 required
inference._types.CohereServiceSettings
object
5 properties
2 required
inference._types.RerankedInferenceResult
object
Defines the response for a rerank request.
1 property
1 required
inference._types.ToolCallFunction
object
The function that the model called.
2 properties
2 required
inference._types.InferenceResult
object
InferenceResult is an aggregation of mutually exclusive variants
9 properties
inference._types.LlamaSimilarityType
string
inference._types.AnthropicServiceType
string
inference._types.TextReasoningDetail
The reasoning text detail includes plaintext reasoning with optional signature verification.
inference._types.DenseByteVector
array
Dense Embedding results containing bytes are represented as Dense Vectors of bytes.
inference._types.RequestEmbedding
object
3 properties
1 required
inference._types.JinaAITextEmbeddingTask
string
inference._types.EmbeddingContentObjectGroup
Allows specifying one or multiple items for the embedding task, which should result in a single embedding vector. Support for multiple items is available in El…
inference._types.InferenceEndpointInfoAlibabaCloudAI
inference._types.DeleteInferenceEndpointResult
Acknowledged response. For dryrun, contains the list of pipelines which reference the inference endpoint
inference._types.CompletionToolType
inference._types.CompletionToolChoiceFunction
object
The tool choice function.
1 property
1 required
inference._types.JinaAITaskSettings
object
4 properties
inference._types.GoogleVertexAITaskType
string
inference._types.ContextualAIServiceSettings
object
3 properties
2 required
inference._types.InferenceEndpointInfoELSER
inference._types.CustomServiceType
string
inference._types.CohereServiceType
string
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
inference._types.TaskTypeHuggingFace
string
inference._types.WatsonxTaskType
string
inference._types.InferenceEndpointInfo
Represents an inference endpoint as returned by the GET API
inference._types.CohereTaskSettings
object
4 properties
1 required
inference._types.OpenShiftAiTaskSettings
object
2 properties
inference._types.OpenShiftAiServiceSettings
object
6 properties
2 required
inference._types.HuggingFaceTaskSettings
object
2 properties
inference._types.ContentType
string
inference._types.ContextualAITaskSettings
object
2 properties
inference._types.TaskTypeVoyageAI
string
inference._types.RequestChatCompletion
object
9 properties
1 required
inference._types.TaskTypeCohere
string
inference._types.TaskTypeGoogleAIStudio
string
inference._types.TaskTypeDeepSeek
string
inference._types.InferenceEndpointInfoOpenAI
inference._types.InferenceEndpointInfoNvidia
inference._types.InferenceEndpointInfoAmazonBedrock
inference._types.CustomServiceQueryParameter
array
inference._types.TaskTypeLlama
string
inference._types.BaseReasoningDetail
object
The base reasoning detail that includes common fields across different types of reasoning details.
3 properties
inference._types.NvidiaTaskType
string
inference._types.OpenAISimilarityType
string
inference._types.EmbeddingInput
Inference input. Either a string, an array of strings, a content object, or an array of content objects.
inference._types.CustomTaskType
string
inference._types.AmazonSageMakerServiceType
string
inference._types.ImageUrl
object
2 properties
1 required
inference.rerank.RerankInputFormat
string
inference._types.CompletionResult
object
The completion result object
1 property
1 required
inference._types.InferenceEndpointInfoAmazonSageMaker
inference._types.InferenceEndpointInfoFireworksAI
inference._types.AzureOpenAIServiceType
string
inference._types.InferenceEndpointInfoVoyageAI
inference._types.EmbeddingInferenceResult
object
EmbeddingInferenceResult is an aggregation of mutually exclusive embeddings variants
3 properties
inference._types.InferenceEndpointInfoLlama
inference._types.EmbeddingContentObject
object
A wrapper object which contains the fields required to specify multimodal inputs
1 property
1 required
inference._types.FireworksAIServiceType
string
inference._types.WatsonxServiceSettings
object
6 properties
5 required
inference._types.InferenceEndpointInfoMistral
inference._types.InferenceEndpointInfoCohere
inference._types.ServiceSettings
object
inference._types.MistralServiceSettings
object
4 properties
2 required
inference._types.CompletionInferenceResult
object
Defines the completion result.
1 property
1 required
inference._types.InferenceChunkingSettings
object
Chunking configuration object
6 properties
inference._types.TaskTypeOpenAI
string
inference._types.InferenceEndpointInfoCustom
inference._types.Ai21TaskType
string
inference.rerank.RerankInput
The documents to rank for the rerank task. Either a string, an array of strings, an object, or an array of objects. The object form additionally allows specify…
inference._types.ElasticsearchTaskSettings
object
1 property
inference._types.SparseEmbeddingInferenceResult
object
The response format for the sparse embedding request.
1 property
1 required
inference._types.GoogleVertexAIServiceSettings
object
10 properties
1 required
inference._types.JinaAISimilarityType
string
inference.rerank.RerankStringInput
Allows specifying text-only documents to rank for the rerank task.
inference._types.JinaAIElementType
string
inference._types.CustomResponseParams
object
1 property
1 required
inference._types.InferenceEndpointInfoHuggingFace
inference._types.GroqServiceType
string
inference._types.AmazonBedrockServiceType
string
inference._types.EmbeddingContentFormat
string
inference._types.TaskTypeGroq
string
inference._types.TaskTypeAi21
string
inference._types.CustomServiceSettings
object
8 properties
3 required
inference._types.AdaptiveAllocations
object
3 properties
inference._types.TaskTypeJinaAi
string
inference._types.NvidiaSimilarityType
string
inference._types.FileContent
object
2 properties
2 required
inference._types.CustomTaskParameter
inference._types.InferenceEndpointInfoAi21
inference._types.CustomRequestParams
object
1 property
1 required
inference._types.TaskTypeAzureAIStudio
string
inference._types.WatsonxServiceType
string
inference._types.FireworksAISimilarityType
string
inference._types.LlamaTaskType
string
inference._types.SparseVector
object
Sparse Embedding tokens are represented as a dictionary of string to double.
inference._types.TaskTypeElasticsearch
string
inference._types.JinaAIServiceSettings
object
7 properties
2 required
inference._types.OpenAIServiceSettings
object
11 properties
1 required
inference._types.DeepSeekServiceType
string
inference._types.SparseEmbeddingResult
object
2 properties
2 required
inference._types.TaskTypeAzureOpenAI
string
inference._types.AmazonSageMakerElementType
string
inference._types.DenseEmbeddingByteResult
object
The dense embedding result object for byte representation
1 property
1 required
inference._types.TaskTypeMistral
string
inference._types.CompletionTool
object
A list of tools that the model can call.
2 properties
2 required
inference._types.OpenAITaskType
string
inference._types.CohereInputType
string
inference._types.AnthropicTaskSettings
object
4 properties
1 required
inference._types.RegionPolicy
object
The region policy configuration. Specify exactly one of allowedgeos or allowedregions.
2 properties
inference._types.ElasticsearchServiceType
string
inference._types.GoogleAiServiceType
string
inference._types.MessageContent
inference._types.Reasoning
object
The reasoning configuration to use for the completion request. Currently supported only for elastic provider.
4 properties
inference._types.OpenAITaskSettings
object
2 properties
inference._types.MistralTaskType
string
inference._types.InferenceEndpointInfoGoogleAIStudio
inference._types.AzureOpenAIServiceSettings
object
10 properties
3 required
inference._types.CustomTaskSettings
object
1 property
inference._types.InferenceEndpointInfoAnthropic
inference._types.ElasticsearchTaskType
string
inference._types.ElasticsearchServiceSettings
object
7 properties
2 required
inference._types.NvidiaInputType
string
inference._types.CspRegion
object
A cloud service provider region.
2 properties
2 required
inference._types.DeepSeekServiceSettings
object
3 properties
2 required
inference._types.EmbeddingStringInput
Allows specifying text-only inputs for the embedding task.
inference._types.HuggingFaceServiceType
string
inference._types.AzureAiStudioServiceType
string
inference._types.AzureOpenAITaskSettings
object
2 properties
inference._types.ReasoningSummary
string
inference._types.OpenShiftAiSimilarityType
string
inference._types.EmbeddingContentInput
Allows specifying multimodal inputs for the embedding task.
inference._types.AmazonSageMakerSimilarity
string
inference._types.GroqServiceSettings
object
3 properties
1 required
inference._types.VoyageAITaskType
string
inference._types.AmazonSageMakerTaskSettings
object
5 properties
inference._types.InferenceEndpointInfoAzureOpenAI
inference._types.JinaAITaskType
string
inference._types.Message
object
An object representing part of the conversation.
6 properties
1 required
inference._types.AlibabaCloudTaskType
string
inference.rerank.RerankObjectInput
Allows specifying documents to rank as objects, which additionally supports non-text inputs, such as images.
inference._types.GroqTaskType
string
inference.rerank.RerankInputType
string
inference._types.AmazonBedrockTaskType
string
inference._types.TaskTypeWatsonx
string
inference._types.NvidiaTaskSettings
object
2 properties
inference._types.RateLimitSetting
object
This setting helps to minimize the number of rate limit errors returned from the service.
1 property
inference._types.GoogleVertexAIServiceType
string
inference._types.GoogleAiStudioServiceSettings
object
3 properties
2 required
inference._types.ToolCall
object
A tool call generated by the model.
3 properties
3 required
inference._types.Ai21ServiceSettings
object
3 properties
1 required
inference._types.InferenceEndpointInfoGroq
inference._types.OpenAIServiceType
string
inference._types.AnthropicTaskType
string
inference._types.AmazonSageMakerServiceSettings
object
12 properties
5 required
inference._types.VoyageAITaskSettings
object
4 properties
inference._types.InferenceEndpointInfoAzureAIStudio
inference._types.AlibabaCloudTaskSettings
object
2 properties
inference._types.TaskTypeNvidia
string
inference._types.AnthropicServiceSettings
object
3 properties
2 required
inference._types.TaskTypeAmazonSageMaker
string
inference._types.HuggingFaceTaskType
string
inference._types.RegionPolicyDoc
object
The stored region policy document.
5 properties
2 required
inference._types.LlamaServiceType
string
inference._types.TaskTypeAnthropic
string
inference._types.AlibabaCloudServiceType
string
inference._types.LlamaServiceSettings
object
5 properties
2 required
inference._types.InferenceEndpointInfoContextualAi
inference._types.EmbeddingContentType
string
inference._types.VoyageAIServiceType
string
inference._types.ReasoningDetail
Type representing the different types of reasoning details that can be included in the response from the model. Currently supported only for elastic provider.
inference._types.CompletionToolChoice
object
Controls which tool is called by the model.
2 properties
2 required
inference._types.InferenceEndpointInfoDeepSeek
inference._types.InferenceEndpointInfoGoogleVertexAI
inference._types.DenseVector
array
Dense Embedding results are represented as Dense Vectors of floats.
inference._types.GoogleVertexAITaskSettings
object
4 properties
inference._types.ElserServiceSettings
object
3 properties
2 required
inference._types.Ai21ServiceType
string
inference._types.TaskTypeAlibabaCloudAI
string
inference._types.SummaryReasoningDetail
The reasoning summary detail includes a high-level summary of the model's reasoning process.
inference._types.AzureAiStudioTaskSettings
object
7 properties
inference._types.OpenShiftAiTaskType
string
inference._types.AzureOpenAITaskType
string
inference._types.ReasoningEffort
string
inference._types.InferenceEndpointInfoWatsonx
inference._types.TextEmbeddingInferenceResult
object
TextEmbeddingInferenceResult is an aggregation of mutually exclusive textembedding variants
3 properties
inference._types.TaskSettings
object
inference._types.NvidiaServiceType
string
inference._types.MistralServiceType
string
inference._types.AmazonSageMakerApi
string
inference._types.JinaAIServiceType
string
inference._types.TaskTypeGoogleVertexAI
string
inference._types.ElserTaskType
string
inference._types.ImageUrlDetail
string
_types.UnitMillis
number
Time unit for milliseconds
inference._types.AlibabaCloudServiceSettings
object
5 properties
4 required
inference._types.TaskTypeELSER
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Elastic Stack (ELK Stack) publishes across the network.