Skip to main content

Reference documentation for GraphQL schema types in the Search category.

Queries

Query

Perform a search across resources, returning a maximum of 1,000 results.

タイプ: SearchResultItemConnection!

search の引数

名前説明

after (String)

Returns the elements in the list that come after the specified cursor.

before (String)

Returns the elements in the list that come before the specified cursor.

first (Int)

Returns the first n elements from the list.

last (Int)

Returns the last n elements from the list.

query (String!)

The search string to look for. GitHub search syntax is supported. For more information, see "Searching on GitHub," "Understanding the search syntax," and "Sorting search results.".

type (SearchType!)

The types of search items to search within.

Objects

SearchResultItemConnection

Object

A list of results that matched against a search query. Regardless of the number of matches, a maximum of 1,000 results will be available across all types, potentially split across many pages.

SearchResultItemConnection のフィールド

名前説明

codeCount (Int!)

The total number of pieces of code that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types.

discussionCount (Int!)

The total number of discussions that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types.

edges ([SearchResultItemEdge])

A list of edges.

issueCount (Int!)

The total number of issues that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types.

issueSearchType (IssueSearchType)

The type of search that was performed for issues (lexical, semantic, or hybrid).

lexicalFallbackReason ([LexicalFallbackReason!])

When a semantic or hybrid search falls back to lexical, the reasons why the fallback occurred.

nodes ([SearchResultItem])

A list of nodes.

pageInfo (PageInfo!)

Information to aid in pagination.

repositoryCount (Int!)

The total number of repositories that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types.

userCount (Int!)

The total number of users that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types.

wikiCount (Int!)

The total number of wiki pages that matched the search query. Regardless of the total number of matches, a maximum of 1,000 results will be available across all types.

SearchResultItemEdge

Object

An edge in a connection.

SearchResultItemEdge のフィールド

名前説明

cursor (String!)

A cursor for use in pagination.

node (SearchResultItem)

The item at the end of the edge.

textMatches ([TextMatch])

Text matches on the result found.

TextMatch

Object

A text match within a search result.

TextMatch のフィールド

名前説明

fragment (String!)

The specific text fragment within the property matched on.

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

property (String!)

The property matched on.

TextMatchHighlight

Object

Represents a single highlight in a search result match.

TextMatchHighlight のフィールド

名前説明

beginIndice (Int!)

The indice in the fragment where the matched text begins.

endIndice (Int!)

The indice in the fragment where the matched text ends.

text (String!)

The text matched.

Enums

LexicalFallbackReason

Enum

Reason why a semantic or hybrid issue search fell back to lexical search.

LexicalFallbackReason の値です。

名前説明
NON_ISSUE_TARGET

Query targets non-issue types (e.g., pull requests).

NO_ACCESSIBLE_REPOS

Scoped query resolved to zero accessible repositories.

NO_TEXT_TERMS

Query has only qualifiers and no free text terms.

ONLY_NON_SEMANTIC_FIELDS_REQUESTED

Query uses an in: qualifier targeting non-semantic fields.

OR_BOOLEAN_NOT_SUPPORTED

Query contains OR operators (nested boolean qualifiers).

QUOTED_TEXT

Query contains quoted text requiring exact matches.

SERVER_ERROR

Embedding generation failed or timed out.

SearchType

Enum

Represents the individual results of a search.

SearchType の値です。

名前説明
DISCUSSION

Returns matching discussions in repositories.

ISSUE

Returns results matching issues in repositories.

ISSUE_ADVANCED

Returns results matching issues in repositories.

ISSUE_HYBRID

Returns results matching issues using hybrid (lexical + semantic) search.

ISSUE_SEMANTIC

Returns results matching issues using semantic search.

REPOSITORY

Returns results matching repositories.

USER

Returns results matching users and organizations on GitHub.

Unions

SearchResultItem

Union

The results of a search.

SearchResultItem の可能な型