ImageAnalysisSkill interface

Package:

@azure/search-documents

A skill that analyzes image files. It extracts a rich set of visual features based on the image content.

Extends

BaseSearchIndexerSkill

Properties

defaultLanguageCode	A value indicating which language code to use. Default is en.
details	A string indicating which domain-specific details to return.
visualFeatures	A list of visual features.

Inherited Properties

context	Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.
description	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
name	The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.
odatatype	Polymorphic discriminator, which specifies the different types this object can be
outputs	The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Property Details

defaultLanguageCode

A value indicating which language code to use. Default is en.

defaultLanguageCode?: "da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "pt-BR" | "ru" | "sv" | "tr" | "az" | "bg" | "bs" | "ca" | "cy" | "et" | "eu" | "ga" | "gl" | "he" | "hi" | "hr" | "id" | "kk" | "lt" | "lv" | "mk" | "ms" | "nb" | "prs" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "zh"

Property Value

"da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt" | "ar" | "cs" | "zh-Hans" | "zh-Hant" | "nl" | "el" | "hu" | "ja" | "pl" | "pt-PT" | "pt-BR" | "ru" | "sv" | "tr" | "az" | "bg" | "bs" | "ca" | "cy" | "et" | "eu" | "ga" | "gl" | "he" | "hi" | "hr" | "id" | "kk" | "lt" | "lv" | "mk" | "ms" | "nb" | "prs" | "ro" | "sk" | "sl" | "sr-Cyrl" | "sr-Latn" | "th" | "uk" | "vi" | "zh"

details

A string indicating which domain-specific details to return.

details?: ("celebrities" | "landmarks")[]

Property Value

("celebrities" | "landmarks")[]

visualFeatures

A list of visual features.

visualFeatures?: ("adult" | "brands" | "categories" | "description" | "faces" | "objects" | "tags")[]

Property Value

("adult" | "brands" | "categories" | "description" | "faces" | "objects" | "tags")[]

Inherited Property Details

context

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

The description of the skill which describes the inputs, outputs, and usage of the skill.

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

odatatype

Polymorphic discriminator, which specifies the different types this object can be

odatatype: "#Microsoft.Skills.Vision.ImageAnalysisSkill"

Property Value

"#Microsoft.Skills.Vision.ImageAnalysisSkill"

Inherited From BaseSearchIndexerSkill.odatatype

outputs

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs