Corpora

Metoda: corpora.create

Tworzy pusty element Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/corpora

Treść żądania

Treść żądania zawiera wystąpienie elementu Corpus.

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „corpora/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie: Wyświetlana nazwa Corpus w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumenty na temat semantycznego wyszukiwania”

Treść odpowiedzi

Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierała nowo utworzoną instancję Corpus.

Metoda: corpora.query

Wykonuje wyszukiwanie semantyczne w ramach Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Parametry ścieżki

name string

Wymagane. Nazwa Corpus, której dotyczy zapytanie. Przykład: corpora/my-corpus-123. Ma on postać corpora/{corpora}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
query string

Wymagane. Ciąg zapytania do przeprowadzenia wyszukiwania semantycznego.

metadataFilters[] object (MetadataFilter)

Opcjonalnie: Filtruj według metadanych Chunk i Document. Każdy obiekt MetadataFilter powinien odpowiadać niepowtarzalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych za pomocą operatora logicznego „ORAZ”.

Przykładowe zapytanie na poziomie dokumentu: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter lista obiektów: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Przykład zapytania na poziomie fragmentu dotyczącego zakresu wartości liczbowych: (year > 2015 AND year <= 2020)

MetadataFilter lista obiektów: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Uwaga: warunki „AND” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. Wartości ciągu obsługują tylko warunki „OR” dla tego samego klucza.

resultsCount integer

Opcjonalnie: Maksymalna liczba Chunk do zwrócenia. Usługa może zwrócić mniej Chunk.

Jeśli nie zostanie podana żadna wartość, zwróci się maksymalnie 10 Chunk. Maksymalna liczba podanych wyników to 100.

Treść odpowiedzi

Odpowiedź z corpora.query zawierająca listę odpowiednich fragmentów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
relevantChunks[] object (RelevantChunk)

odpowiednie fragmenty.

Zapis JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metoda: corpora.list

Wyświetla wszystkie Corpora należące do użytkownika.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/corpora

Parametry zapytania

pageSize integer

Opcjonalnie: Maksymalna liczba Corpora do zwrócenia (na stronę). Usługa może zwrócić mniej Corpora.

Jeśli nie podasz wartości, zwróci się maksymalnie 10 Corpora. Maksymalny rozmiar to 20 Corpora na stronę.

pageToken string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji corpora.list.

Aby pobrać kolejną stronę, podaj jako argument kolejnego żądania nextPageToken zwrócony w odpowiedzi.

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji corpora.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z corpora.list zawierająca ponumerowane strony z Corpora. Wyniki są sortowane według rosnącej wartości corpus.create_time.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
corpora[] object (Corpus)

Zwrócone korpusy.

nextPageToken string

token, który może być wysyłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.

Zapis JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Metoda: corpora.get

Pobiera informacje o konkretnym Corpus.

Punkt końcowy

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parametry ścieżki

name string

Wymagane. Nazwa Corpus. Przykład: corpora/my-corpus-123. Ma on postać corpora/{corpora}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Corpus.

Metoda: corpora.patch

Zaktualizowano Corpus.

Punkt końcowy

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Parametry ścieżki

corpus.name string

Niezmienna. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa z wyjątkiem prefiksu „corpora/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/my-awesome-corpora-123a456b789c. Ma on postać corpora/{corpora}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagane. Lista pól do zaktualizowania. Obecnie ta funkcja obsługuje tylko aktualizowanie displayName.

Jest to lista pełnych nazw pól rozdzielona przecinkami. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Corpus.

Pola
displayName string

Opcjonalnie: Wyświetlana nazwa Corpus w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumenty na temat semantycznego wyszukiwania”

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Corpus.

Metoda: corpora.delete

usuwa Corpus.

Punkt końcowy

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Corpus. Przykład: corpora/my-corpus-123. Ma on postać corpora/{corpora}.

Parametry zapytania

force boolean

Opcjonalnie: Jeśli wartość to „true”, zostaną również usunięte wszystkie Document i obiekty powiązane z tym Corpus.

Jeśli wartość jest równa fałsz (domyślnie), zwracany jest błąd FAILED_PRECONDITION, jeśli Corpus zawiera jakiekolwiek wartości Document.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi to pusty obiekt JSON.

Zasób REST: corpora.permissions

Zasób: Permission

Zasób uprawnień przyznaje użytkownikowi, grupie lub reszcie świata dostęp do zasobu PaLM API (np. dostrojonego modelu lub korpus).

Rola to zbiór dozwolonych operacji, który umożliwia użytkownikom wykonywanie określonych działań na zasobach PaLM API. Aby udostępnić je użytkownikom, grupom lub kontom usługi, przypisz role. Przypisując rolę, przyznajesz uprawnienia, które są z nią powiązane.

Istnieją 3 poziomy roli. Każda rola jest superzbiorem dozwolonych operacji poprzedniej roli:

  • reader może używać zasobu (np.dostosowanego modelu lub korpusu) do wnioskowania.
  • użytkownik o roli „Writer” (Autor) ma uprawnienia użytkownika o roli „Reader” (Czytelnik) i dodatkowo może edytować i udostępniać pliki
  • właściciel ma uprawnienia autora i dodatkowo może usuwać
Fields
name string

Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Tylko dane wyjściowe.

granteeType enum (GranteeType)

Opcjonalnie: Niezmienna. Typ podmiotu, któremu udzielono uprawnienia.

emailAddress string

Opcjonalnie: Niezmienna. Adres e-mail użytkownika grupy, do której odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ uprawnienia to WSZYSCY.

role enum (Role)

Wymagane. Rola przyznana przez to uprawnienie.

Zapis JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Definiuje typy podmiotów, którym udzielono tego uprawnienia.

Wartości w polu enum
GRANTEE_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
USER Reprezentuje użytkownika. Gdy to ustawienie jest ustawione, musisz podać adres e-mail użytkownika.
GROUP Reprezentuje grupę. Gdy jest ustawiony, musisz podać adres e-mail grupy.
EVERYONE Reprezentuje dostęp dla wszystkich. Nie musisz podawać żadnych dodatkowych informacji.

Rola

Określa rolę przyznaną przez to uprawnienie.

Wartości w polu enum
ROLE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OWNER Właściciel może używać, aktualizować, udostępniać i usuwać zasób.
WRITER Autor może używać, aktualizować i udostępniać zasób.
READER Czytelnik może korzystać z zasobu.

MetadataFilter

Filtr dostarczony przez użytkownika, który ogranicza odzyskiwanie na podstawie wartości metadanych na poziomie Chunk lub Document. Przykład (gatunek = dramat LUB gatunek = akcja): key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

Pola
key string

Wymagane. Klucz metadanych, według którego chcesz filtrować.

conditions[] object (Condition)

Wymagane. Condition dla danego klucza, które powoduje działanie tego filtra. Wiele elementów Condition jest połączonych za pomocą operatora logicznego LUB.

Zapis JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Warunek

Warunek filtra dotyczący pojedynczego klucza.

Pola
operation enum (Operator)

Wymagane. Operator zastosowany do danej pary klucz-wartość w celu wywołania warunku.

value Union type
Typ wartości musi być zgodny z typem wartości zdefiniowanym w polu dla odpowiedniego klucza. Jeśli typy wartości są niespójne, wynik będzie pusty. Jeśli CustomMetadata ma typ wartości StringList, warunek filtrowania powinien używać string_value w połączeniu z operacją OBEJMUJE/NIEOBEJMUJE. W przeciwnym razie wynik będzie też pustym zbiorem. value może być tylko jednym z tych elementów:
stringValue string

Wartość ciągu, według której chcesz filtrować metadane.

numericValue number

Wartość liczbowa, według której chcesz filtrować metadane.

Zapis JSON 
{
  "operation": enum (Operator),

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

Operator

Określa prawidłowe operatory, które można zastosować do pary klucz-wartość.

Wartości w polu enum
OPERATOR_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
LESS Obsługiwane przez typ danych Numeryczny.
LESS_EQUAL Obsługiwane przez typ danych Numeryczny.
EQUAL Obsługiwane przez liczby i ciągi znaków.
GREATER_EQUAL Obsługiwane przez typ numeric.
GREATER Obsługiwane przez typ danych Numeryczny.
NOT_EQUAL Obsługiwane przez liczby i ciągi znaków.
INCLUDES Obsługiwane przez ciągi znaków tylko wtedy, gdy typ wartości CustomMetadata dla danego klucza ma wartość stringListValue.
EXCLUDES Obsługiwane przez ciąg znaków tylko wtedy, gdy typ wartości CustomMetadata dla danego klucza ma wartość stringListValue.

RelevantChunk

Informacje o fragmentach danych istotnych dla zapytania.

Pola
chunkRelevanceScore number

Chunk trafność w odniesieniu do zapytania.

chunk object (Chunk)

Chunk powiązany z zapytaniem.

Zapis JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

Zasób REST: corpora

Zasób: Corpus

Corpus to zbiór Document. Projekt może utworzyć maksymalnie 5 korpusów.

Pola
name string

Niezmienna. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „corpora/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie: Wyświetlana nazwa Corpus w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumenty na temat semantycznego wyszukiwania”

createTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia elementu Corpus.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy element Corpus został ostatnio zaktualizowany.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}