Microsoft Azure Search Index Client

The Microsoft Azure Search Index Client is a tool that allows developers to create and manage search indexes within their applications. This client enables users to easily integrate powerful search capabilities into their services, making it easier for end-users to find relevant information quickly. With the Index Client, developers can define the structure of their search indexes, upload and manage content, perform advanced search queries, and retrieve search results efficiently.

OpenAPI Specification

searchindexclient-openapi-original.yml Raw ↑
swagger: '2.0'
info:
  title: Microsoft Azure SearchIndexClient
  description: >-
    Client that can be used to query an Azure Search index and upload, merge, or
    delete documents.
  version: 2017-11-11-Preview
  x-ms-code-generation-settings:
    useDateTimeOffset: true
    syncMethods: None
x-ms-parameterized-host:
  hostTemplate: https://{searchServiceName}.{searchDnsSuffix}/indexes('{indexName}')
  useSchemePrefix: false
  parameters:
    - $ref: '#/parameters/SearchServiceNameParameter'
    - $ref: '#/parameters/SearchDnsSuffixParameter'
    - $ref: '#/parameters/IndexNameParameter'
consumes:
  - application/json
produces:
  - application/json
paths:
  /docs/$count:
    get:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsCount
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Count-Documents
      x-ms-examples:
        SearchIndexCountDocuments:
          $ref: ./examples/SearchIndexCountDocuments.json
      description: Queries the number of documents in the Azure Search index.
      parameters:
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            type: integer
            format: int64
      summary: Microsoft Azure Get Docs $count
  /docs:
    get:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsSearchget
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Search-Documents
      x-ms-examples:
        SearchIndexSearchDocumentsGet:
          $ref: ./examples/SearchIndexSearchDocumentsGet.json
      description: Searches for documents in the Azure Search index.
      parameters:
        - name: search
          in: query
          type: string
          description: >-
            A full-text search query expression; Use "*" or omit this parameter
            to match all documents.
          x-ms-client-name: SearchText
        - name: $count
          in: query
          type: boolean
          description: >-
            A value that specifies whether to fetch the total count of results.
            Default is false. Setting this value to true may have a performance
            impact. Note that the count returned is an approximation.
          x-nullable: false
          x-ms-client-name: IncludeTotalResultCount
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: facet
          in: query
          type: array
          items:
            type: string
          collectionFormat: multi
          description: >-
            The list of facet expressions to apply to the search query. Each
            facet expression contains a field name, optionally followed by a
            comma-separated list of name:value pairs.
          x-ms-client-name: Facets
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: $filter
          in: query
          type: string
          description: The OData $filter expression to apply to the search query.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: highlight
          in: query
          type: array
          items:
            type: string
          description: >-
            The list of field names to use for hit highlights. Only searchable
            fields can be used for hit highlighting.
          x-ms-client-name: HighlightFields
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: highlightPostTag
          in: query
          type: string
          description: >-
            A string tag that is appended to hit highlights. Must be set with
            highlightPreTag. Default is </em>.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: highlightPreTag
          in: query
          type: string
          description: >-
            A string tag that is prepended to hit highlights. Must be set with
            highlightPostTag. Default is <em>.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: minimumCoverage
          in: query
          type: number
          format: double
          description: >-
            A number between 0 and 100 indicating the percentage of the index
            that must be covered by a search query in order for the query to be
            reported as a success. This parameter can be useful for ensuring
            search availability even for services with only one replica. The
            default is 100.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: $orderby
          in: query
          type: array
          items:
            type: string
          description: >-
            The list of OData $orderby expressions by which to sort the results.
            Each expression can be either a field name or a call to either the
            geo.distance() or the search.score() functions. Each expression can
            be followed by asc to indicate ascending, and desc to indicate
            descending. The default is ascending order. Ties will be broken by
            the match scores of documents. If no OrderBy is specified, the
            default sort order is descending by document match score. There can
            be at most 32 $orderby clauses.
          x-ms-client-name: OrderBy
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: queryType
          in: query
          type: string
          enum:
            - simple
            - full
          x-ms-enum:
            name: QueryType
            modelAsString: false
          x-nullable: false
          description: >-
            A value that specifies the syntax of the search query. The default
            is 'simple'. Use 'full' if your query uses the Lucene query syntax.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: scoringParameter
          in: query
          type: array
          items:
            type: string
          collectionFormat: multi
          x-ms-client-name: ScoringParameters
          description: >-
            The list of parameter values to be used in scoring functions (for
            example, referencePointParameter) using the format name-values. For
            example, if the scoring profile defines a function with a parameter
            called 'mylocation' the parameter string would be
            "mylocation--122.2,44.8" (without the quotes).
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: scoringProfile
          in: query
          type: string
          description: >-
            The name of a scoring profile to evaluate match scores for matching
            documents in order to sort the results.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: searchFields
          in: query
          type: array
          items:
            type: string
          description: The list of field names to include in the full-text search.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: searchMode
          in: query
          type: string
          enum:
            - any
            - all
          x-ms-enum:
            name: SearchMode
            modelAsString: false
          x-nullable: false
          description: >-
            A value that specifies whether any or all of the search terms must
            be matched in order to count the document as a match.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: $select
          in: query
          type: array
          items:
            type: string
          description: >-
            The list of fields to retrieve. If unspecified, all fields marked as
            retrievable in the schema are included.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: $skip
          in: query
          type: integer
          format: int32
          description: >-
            The number of search results to skip. This value cannot be greater
            than 100,000. If you need to scan documents in sequence, but cannot
            use $skip due to this limitation, consider using $orderby on a
            totally-ordered key and $filter with a range query instead.
          x-ms-parameter-grouping:
            name: SearchParameters
        - name: $top
          in: query
          type: integer
          format: int32
          description: >-
            The number of search results to retrieve. This can be used in
            conjunction with $skip to implement client-side paging of search
            results. If results are truncated due to server-side paging, the
            response will include a continuation token that can be used to issue
            another Search request for the next page of results.
          x-ms-parameter-grouping:
            name: SearchParameters
        - $ref: '#/parameters/ApiVersionParameter'
        - $ref: '#/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing documents that match the search criteria.
          schema:
            $ref: '#/definitions/DocumentSearchResult'
      summary: Microsoft Azure Get Docs
  /docs/search.post.search:
    post:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsSearchpost
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/Search-Documents
      x-ms-examples:
        SearchIndexSearchDocumentsPost:
          $ref: ./examples/SearchIndexSearchDocumentsPost.json
      description: Searches for documents in the Azure Search index.
      parameters:
        - name: searchRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/SearchRequest'
            description: The Search request.
          description: The definition of the Search request.
        - $ref: '#/parameters/ApiVersionParameter'
        - $ref: '#/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: Response containing documents that match the search criteria.
          schema:
            $ref: '#/definitions/DocumentSearchResult'
      summary: Microsoft Azure Post Docs Search Post Search
  /docs('{key}'):
    get:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsGet
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/lookup-document
      x-ms-examples:
        SearchIndexGetDocument:
          $ref: ./examples/SearchIndexGetDocument.json
      description: Retrieves a document from the Azure Search index.
      parameters:
        - name: key
          in: path
          required: true
          description: The key of the document to retrieve.
          type: string
        - name: $select
          in: query
          type: array
          items:
            type: string
          description: >-
            List of field names to retrieve for the document; Any field not
            retrieved will be missing from the returned document.
          x-ms-client-name: SelectedFields
        - $ref: '#/parameters/ApiVersionParameter'
        - $ref: '#/parameters/ClientRequestIdParameter'
      responses:
        '200':
          description: Response containing the requested document.
          schema:
            type: object
      summary: 'Microsoft Azure Get Docs Key'
  /docs/search.suggest:
    get:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsSuggestget
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/suggestions
      x-ms-examples:
        SearchIndexSuggestDocumentsGet:
          $ref: ./examples/SearchIndexSuggestDocumentsGet.json
      description: >-
        Suggests documents in the Azure Search index that match the given
        partial query text.
      parameters:
        - name: search
          in: query
          required: true
          type: string
          description: >-
            The search text to use to suggest documents. Must be at least 1
            character, and no more than 100 characters.
          x-ms-client-name: SearchText
        - name: suggesterName
          in: query
          required: true
          type: string
          description: >-
            The name of the suggester as specified in the suggesters collection
            that's part of the index definition.
        - name: $filter
          in: query
          type: string
          description: >-
            An OData expression that filters the documents considered for
            suggestions.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: fuzzy
          in: query
          type: boolean
          description: >-
            A value indicating whether to use fuzzy matching for the suggestions
            query. Default is false. When set to true, the query will find terms
            even if there's a substituted or missing character in the search
            text. While this provides a better experience in some scenarios, it
            comes at a performance cost as fuzzy suggestions queries are slower
            and consume more resources.
          x-ms-client-name: UseFuzzyMatching
          x-nullable: false
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: highlightPostTag
          in: query
          type: string
          description: >-
            A string tag that is appended to hit highlights. Must be set with
            highlightPreTag. If omitted, hit highlighting of suggestions is
            disabled.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: highlightPreTag
          in: query
          type: string
          description: >-
            A string tag that is prepended to hit highlights. Must be set with
            highlightPostTag. If omitted, hit highlighting of suggestions is
            disabled.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: minimumCoverage
          in: query
          type: number
          format: double
          description: >-
            A number between 0 and 100 indicating the percentage of the index
            that must be covered by a suggestions query in order for the query
            to be reported as a success. This parameter can be useful for
            ensuring search availability even for services with only one
            replica. The default is 80.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: $orderby
          in: query
          type: array
          items:
            type: string
          x-ms-client-name: OrderBy
          description: >-
            The list of OData $orderby expressions by which to sort the results.
            Each expression can be either a field name or a call to either the
            geo.distance() or the search.score() functions. Each expression can
            be followed by asc to indicate ascending, or desc to indicate
            descending. The default is ascending order. Ties will be broken by
            the match scores of documents. If no $orderby is specified, the
            default sort order is descending by document match score. There can
            be at most 32 $orderby clauses.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: searchFields
          in: query
          type: array
          items:
            type: string
          description: >-
            The list of field names to search for the specified search text.
            Target fields must be included in the specified suggester.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: $select
          in: query
          type: array
          items:
            type: string
          description: >-
            The list of fields to retrieve. If unspecified, only the key field
            will be included in the results.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - name: $top
          in: query
          type: integer
          format: int32
          description: >-
            The number of suggestions to retrieve. The value must be a number
            between 1 and 100. The default is 5.
          x-ms-parameter-grouping:
            name: SuggestParameters
        - $ref: '#/parameters/ApiVersionParameter'
        - $ref: '#/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: >-
            Response containing suggested documents that match the partial
            input.
          schema:
            $ref: '#/definitions/DocumentSuggestResult'
      summary: Microsoft Azure Get Docs Search Suggest
  /docs/search.post.suggest:
    post:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsSuggestpost
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/suggestions
      x-ms-examples:
        SearchIndexSuggestDocumentsPost:
          $ref: ./examples/SearchIndexSuggestDocumentsPost.json
      description: >-
        Suggests documents in the Azure Search index that match the given
        partial query text.
      parameters:
        - name: suggestRequest
          in: body
          required: true
          description: The Suggest request.
          schema:
            $ref: '#/definitions/SuggestRequest'
        - $ref: '#/parameters/ApiVersionParameter'
        - $ref: '#/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: >-
            Response containing suggested documents that match the partial
            input.
          schema:
            $ref: '#/definitions/DocumentSuggestResult'
      summary: Microsoft Azure Post Docs Search Post Suggest
  /docs/search.index:
    post:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsIndex
      externalDocs:
        url: >-
          https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents
      x-ms-examples:
        SearchIndexIndexDocuments:
          $ref: ./examples/SearchIndexIndexDocuments.json
      description: Sends a batch of document write actions to the Azure Search index.
      parameters:
        - name: batch
          in: body
          description: The batch of index actions.
          required: true
          schema:
            $ref: '#/definitions/IndexBatch'
        - $ref: '#/parameters/ApiVersionParameter'
        - $ref: '#/parameters/ClientRequestIdParameter'
      x-ms-request-id: request-id
      responses:
        '200':
          description: >-
            Response containing the status of operations for all actions in the
            batch.
          schema:
            $ref: '#/definitions/DocumentIndexResult'
        '207':
          description: >-
            Response containing the status of operations for all actions in the
            batch.
          schema:
            $ref: '#/definitions/DocumentIndexResult'
      summary: Microsoft Azure Post Docs Search Index
  /docs/search.autocomplete:
    get:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsAutocompleteget
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/autocomplete
      x-ms-examples:
        SearchIndexAutocompleteDocumentsGet:
          $ref: ./examples/SearchIndexAutocompleteDocumentsGet.json
      description: >-
        Autocompletes incomplete query terms based on input text and matching
        terms in the Azure Search index.
      parameters:
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
        - name: search
          in: query
          type: string
          required: true
          description: The incomplete term which should be auto-completed.
          x-ms-client-name: SearchText
        - name: suggesterName
          in: query
          type: string
          required: true
          description: >-
            The name of the suggester as specified in the suggesters collection
            that's part of the index definition.
        - name: autocompleteMode
          in: query
          type: string
          x-nullable: false
          enum:
            - oneTerm
            - twoTerms
            - oneTermWithContext
          x-ms-enum:
            name: AutocompleteMode
            modelAsString: false
          description: >-
            Specifies the mode for Autocomplete. The default is 'oneTerm'. Use
            'twoTerms' to get shingles and 'oneTermWithContext' to use the
            current context while producing auto-completed terms.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: $filter
          in: query
          type: string
          description: >-
            An OData expression that filters the documents used to produce
            completed terms for the Autocomplete result.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: fuzzy
          in: query
          type: boolean
          description: >-
            A value indicating whether to use fuzzy matching for the
            autocomplete query. Default is false. When set to true, the query
            will find terms even if there's a substituted or missing character
            in the search text. While this provides a better experience in some
            scenarios, it comes at a performance cost as fuzzy autocomplete
            queries are slower and consume more resources.
          x-ms-client-name: UseFuzzyMatching
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: highlightPostTag
          in: query
          type: string
          description: >-
            A string tag that is appended to hit highlights. Must be set with
            highlightPreTag. If omitted, hit highlighting is disabled.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: highlightPreTag
          in: query
          type: string
          description: >-
            A string tag that is prepended to hit highlights. Must be set with
            highlightPostTag. If omitted, hit highlighting is disabled.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: minimumCoverage
          in: query
          type: number
          format: double
          description: >-
            A number between 0 and 100 indicating the percentage of the index
            that must be covered by an autocomplete query in order for the query
            to be reported as a success. This parameter can be useful for
            ensuring search availability even for services with only one
            replica. The default is 80.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: searchFields
          in: query
          type: array
          items:
            type: string
          description: >-
            The list of field names to consider when querying for auto-completed
            terms. Target fields must be included in the specified suggester.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
        - name: $top
          in: query
          type: integer
          format: int32
          description: >-
            The number of auto-completed terms to retrieve. This must be a value
            between 1 and 100. The default is 5.
          x-ms-parameter-grouping:
            name: AutocompleteParameters
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AutocompleteResult'
            description: The result of Autocomplete query.
      summary: Microsoft Azure Get Docs Search Autocomplete
  /docs/search.post.autocomplete:
    post:
      tags:
        - Documents
      operationId: microsoftAzureDocumentsAutocompletepost
      externalDocs:
        url: https://docs.microsoft.com/rest/api/searchservice/autocomplete
      x-ms-examples:
        SearchIndexAutocompleteDocumentsPost:
          $ref: ./examples/SearchIndexAutocompleteDocumentsPost.json
      description: >-
        Autocompletes incomplete query terms based on input text and matching
        terms in the Azure Search index.
      parameters:
        - $ref: '#/parameters/ClientRequestIdParameter'
        - $ref: '#/parameters/ApiVersionParameter'
        - name: autocompleteRequest
          in: body
          required: true
          schema:
            $ref: '#/definitions/AutocompleteRequest'
          description: The definition of the Autocomplete request.
      x-ms-request-id: request-id
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AutocompleteResult'
            description: The result of Autocomplete query.
      summary: Microsoft Azure Post Docs Search Post Autocomplete
definitions:
  DocumentSuggestResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SuggestResult'
        readOnly: true
        x-ms-client-name: Results
        description: The sequence of results returned by the query.
      '@search.coverage':
        type: number
        readOnly: true
        format: double
        x-ms-client-name: Coverage
        description: >-
          A value indicating the percentage of the index that was included in
          the query, or null if minimumCoverage was not set in the request.
    description: Response containing suggestion query results from an Azure Search index.
  SuggestResult:
    properties:
      '@search.text':
        type: string
        readOnly: true
        description: The text of the suggestion result.
        x-ms-client-name: Text
    additionalProperties: true
    description: >-
      A result containing a document found by a suggestion query, plus
      associated metadata.
  FacetResult:
    properties:
      count:
        type: integer
        format: int64
        readOnly: true
        description: >-
          The approximate count of documents falling within the bucket described
          by this facet.
    additionalProperties: true
    description: >-
      A single bucket of a facet query result. Reports the number of documents
      with a field value falling within a particular range or having a
      particular value or interval.
  DocumentSearchResult:
    properties:
      '@odata.count':
        type: integer
        format: int64
        readOnly: true
        x-ms-client-name: Count
        description: >-
          The total count of results found by the search operation, or null if
          the count was not requested. If present, the count may be greater than
          the number of results in this response. This can happen if you use the
          $top or $skip parameters, or if Azure Search can't return all the
          requested documents in a single Search response.
      '@search.coverage':
        type: number
        format: double
        readOnly: true
        x-ms-client-name: Coverage
        description: >-
          A value indicating the percentage of the index that was included in
          the query, or null if minimumCoverage was not specified in the
          request.
      '@search.facets':
        type: object
        additionalProperties:
          type: array
          items:
            $ref: '#/definitions/FacetResult'
        readOnly: true
        x-ms-client-name: Facets
        description: >-
          The facet query results for the search operation, organized as a
          collection of buckets for each faceted field; null if the query did
          not include any facet expressions.
      '@search.nextPageParameters':
        $ref: '#/definitions/SearchRequest'
        readOnly: true
        x-ms-client-name: NextPageParameters
        description: >-
          Continuation JSON payload returned when Azure Search can't return all
          the requested results in a single Search response. You can use this
          JSON along with @odata.nextLink to formulate another POST Search
          request to get the next part of the search response.
      value:
        type: array
        items:
          $ref: '#/definitions/SearchResult'
        readOnly: true
        x-ms-client-name: Results
        description: The sequence of results returned by the query.
      '@odata.nextLink':
        type: string
        readOnly: true
        x-ms-client-name: NextLink
        description: >-
          Continuation URL returned when Azure Search can't return all the
          requested results in a single Search response. You can use this URL to
          formulate another GET or POST Search request to get the next part of
          the search response. Make sure to use the same verb (GET or POST) as
          the request that produced this response.
    description: Response containing search results from an Azure Search index.
  SearchResult:
    properties:
      '@search.score':
        type: number
        format: double
        readOnly: true
        x-ms-client-name: Score
        x-nullable: false
        description: >-
          The relevance score of the document compared to other documents
          returned by the query.
      '@search.highlights':
        type: object
        additionalProperties:
          type: array
          items:
            type: string
        readOnly: true
        x-ms-client-name: Highlights
        description: >-
          Text fragments from the document that indicate the matching search
          terms, organized by each applicable field; null if hit highlighting
          was not enabled for the query.
    additionalProperties: true
    description: Contains a document found by a search query, plus associated metadata.
  IndexBatch:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/IndexAction'
        description: The actions in the batch.
        x-ms-client-name: Actions
    required:
      - value
    description: >-
      Contains a batch of document write actions to send to the Azure Search
      index.
  IndexAction:
    properties:
      '@search.action':
        type: string
        enum:
          - upload
          - merge
          - mergeOrUpload
          - delete
        x-ms-enum:
          name: IndexActionType
        x-ms-client-name: ActionType
        x-nullable: false
        description: The operation to perform on a document in an indexing batch.
    additionalProperties: true
    description: Represents an index action that operates on a document.
  IndexingResult:
    properties:
      key:
        type: string
        readOnly: true
        description: The key of a document that was in the indexing request.
      errorMessage:
        type: string
        readOnly: true
        description: >-
          The error message explaining why the indexing operation failed for the
          document identified by the key; null if indexing succeeded.
      status:
        x-ms-client-name: Succeeded
        type: boolean
        x-nullable: false
        readOnly: true
        description: >-
          A value indicating whether the indexing operation succeeded for the
          document identified by the key.
      statusCode:
        type: integer
        format: int32
        x-nullable: false
        readOnly: true
        description: >-
          The status code of the indexing operation. Possible values include:
          200 for a successful update or delete, 201 for successful document
          creation, 400 for a malformed input document, 404 for document not
          found, 409 for a version conflict, 422 when the index is temporarily
          unavailable, or 503 for when the service is too busy.
    description: Status of an indexing operation for a single document.
  DocumentIndexResult:
    properties:
      value:
        x-ms-client-name: Results
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/IndexingResult'
        description: >-
          The list 

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/searchindexclient-openapi-original.yml